@appsemble/utils 0.20.45 → 0.21.1

package/reference-schemas/remappers/objects.js

@@ -0,0 +1,157 @@
+export const objectRemappers = {
+    'object.assign': {
+        additionalProperties: {
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        description: `
+
+Let’s say you have an existing object that you want to add an additional value on top of. For this
+you can use the \`object.assign\` remapper. The remapper takes an existing object and allows the user
+to assign their own value on top of that.
+
+Input:
+
+\`\`\`json
+{
+  "title": "Weekly fishing 21"
+}
+\`\`\`
+
+\`\`\`yaml
+object.assign:
+  author: John Doe
+\`\`\`
+
+Result:
+
+\`\`\`json
+{
+  "title": "Weekly fishing 21",
+  "author": "John Doe"
+}
+\`\`\`
+
+`,
+    },
+    'object.from': {
+        additionalProperties: {
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        description: `
+
+With this remapper you can create an entirely new object based on input values and other remappers.
+\`object.from\` itself accepts remapper functions as its input which allows you to chain multiple
+remappers together to make complex objects.
+
+As a base, the remapper looks like this:
+
+\`\`\`yaml
+object.from:
+  username: Chris Taub
+  email: example@hotmail.com
+\`\`\`
+
+\`\`\`json
+{
+  "username": "Chris Taub",
+  "email": "example@hotmail.com"
+}
+\`\`\`
+
+Most of the time you won’t create an object just to store one value. Luckily, this is where the
+chaining of remappers comes in. You can create an object that contains an \`object.from\` remapper
+which then allows more inputs:
+
+\`\`\`yaml
+object.from:
+  username: Chris Taub
+  email: example@hotmail.com
+  addresses:
+    object.from:
+      work:
+        object.from:
+          city: Eindhoven
+          address: Nachtegaallaan 15
+      home:
+        object.from:
+          city: Amsterdam
+          address: Amstel 1
+\`\`\`
+
+\`\`\`json
+{
+  "username": "Chris Taub",
+  "email": "example@hotmail.com",
+  "addresses": {
+    "work": {
+      "city": "Eindhoven",
+      "address": "Nachtegaallaan 15"
+    },
+    "home": {
+      "city": "Amsterdam",
+      "address": "Amstel 1"
+    }
+  }
+}
+\`\`\`
+
+`,
+    },
+    'object.omit': {
+        type: 'array',
+        items: {
+            minItems: 1,
+            anyOf: [
+                { type: 'string' },
+                {
+                    type: 'array',
+                    minItems: 2,
+                    items: {
+                        type: 'string',
+                    },
+                },
+            ],
+        },
+        description: `
+
+In contrary to the previous remapper, what if you have an object from which you want to remove a
+value? Then you can use \`object.omit\`. The remapper can remove properties from an existing object
+based on the given object keys. This includes nested properties.
+
+Input:
+
+\`\`\`json
+{
+  "title": "Weekly fishing 21",
+  "author": "John Doe",
+  "content": {
+    "introduction": "This is the introduction for the new weekly fishing issue",
+    "paragraph1": "...",
+    "interview": "..."
+  }
+}
+\`\`\`
+
+\`\`\`yaml
+object.omit:
+  - author
+  - - content
+    - interview
+\`\`\`
+
+Result:
+
+\`\`\`json
+{
+  "title": "Weekly fishing 21",
+  "content": {
+    "introduction": "This is the introduction for the new weekly fishing issue",
+    "paragraph1": "..."
+  }
+}
+\`\`\`
+
+`,
+    },
+};
+//# sourceMappingURL=objects.js.map

package/reference-schemas/remappers/randoms.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const randomRemappers: Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject>;

package/reference-schemas/remappers/randoms.js

@@ -0,0 +1,35 @@
+export const randomRemappers = {
+    'random.choice': {
+        enum: [null],
+        description: 'Pick and return a random entry from an array. If the input is not an array, the input is returned as-is.',
+    },
+    'random.integer': {
+        type: 'array',
+        maxItems: 2,
+        minItems: 2,
+        items: {
+            type: 'integer',
+        },
+        description: 'Pick and return a random integer between the provided lowest and highest values.',
+    },
+    'random.float': {
+        type: 'array',
+        maxItems: 2,
+        minItems: 2,
+        items: {
+            type: 'number',
+        },
+        description: 'Pick and return a random number between the provided lowest and highest values.',
+    },
+    'random.string': {
+        type: 'object',
+        required: ['choice', 'length'],
+        additionalProperties: false,
+        properties: {
+            choice: { type: 'string', minLength: 1 },
+            length: { type: 'integer', minimum: 1 },
+        },
+        description: 'Pick and return a random string from a given length using characters from a given input string.',
+    },
+};
+//# sourceMappingURL=randoms.js.map

package/reference-schemas/remappers/strings.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const stringRemappers: Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject>;

package/reference-schemas/remappers/strings.js

@@ -0,0 +1,81 @@
+export const stringRemappers = {
+    'string.case': {
+        enum: ['lower', 'upper'],
+        description: `Convert a string to upper or lower case.
+\`\`\`yaml
+string.case: upper
+\`\`\`
+
+Result:
+
+\`\`\`json
+"PATRICK"
+\`\`\`
+
+`,
+    },
+    'string.format': {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+            messageId: {
+                type: 'string',
+                description: 'The message id pointing to the template string to format.',
+            },
+            template: {
+                type: 'string',
+                description: 'The template default string to format.',
+            },
+            values: {
+                description: 'A set of remappers to convert the input to usable values.',
+                additionalProperties: {
+                    $ref: '#/components/schemas/RemapperDefinition',
+                },
+            },
+        },
+        description: `Format a string using remapped input variables.
+Useful for replacing static text with generated values.
+
+\`\`\`yaml
+string.format:
+  template: 'You have won €{lotteryAmount} in the lottery!!'
+  values:
+    lotteryAmount: { prop: lotteryPrize }
+\`\`\`
+
+Result:
+
+\`\`\`json
+"You have won €5000 in the lottery!!"
+\`\`\`
+
+> **Tip:** Considering this can be inserted anywhere a remapper is accepted. You can also use this
+> to choose specific URL’s more accurately.
+
+`,
+    },
+    'string.replace': {
+        type: 'object',
+        minProperties: 1,
+        maxProperties: 1,
+        additionalProperties: {
+            type: 'string',
+        },
+        description: `
+Uses RegEx to find a value in a string and replace it with a given value.
+
+\`\`\`yaml
+# Input: Eindhoven is the best city in the Netherlands
+string.replace:
+  (beszt*)\\w+: cleanest
+\`\`\`
+
+Result:
+
+\`\`\`json
+"Eindhoven is the cleanest city in the Netherlands"
+\`\`\`
+`,
+    },
+};
+//# sourceMappingURL=strings.js.map

package/reference-schemas/remappers/unsorted.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const unsortedRemappers: Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject>;

package/reference-schemas/remappers/unsorted.js

@@ -0,0 +1,71 @@
+export const unsortedRemappers = {
+    ics: {
+        type: 'object',
+        description: 'Create a calendar event',
+        additionalProperties: false,
+        required: ['start', 'title'],
+        properties: {
+            start: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'The start of the icalendar event.',
+            },
+            end: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'The end of the icalendar event.',
+            },
+            duration: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'The duration of the event.',
+                example: '1w 3d 10h 30m',
+            },
+            title: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'The title of the event.',
+            },
+            description: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'An optional description of the event.',
+            },
+            url: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'An optional link to attach to the event.',
+            },
+            location: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: 'An optional location description to attach to the event.',
+            },
+            coordinates: {
+                $ref: '#/components/schemas/RemapperDefinition',
+                description: `An optional geolocation description to attach to the event.
+
+  This must be an object with the properties \`lat\` or \`latitude\`, and \`lon\`, \`lng\` or \`longitude\`.`,
+            },
+        },
+    },
+    'null.strip': {
+        description: 'Strip all null, undefined, and empty array values from an object.',
+        anyOf: [
+            { enum: [null] },
+            {
+                type: 'object',
+                required: ['depth'],
+                additionalProperties: false,
+                description: 'Options for the null.strip remapper.',
+                properties: {
+                    depth: {
+                        type: 'integer',
+                        minimum: 1,
+                        description: 'How deep to recurse into objects and arrays to remove null values.',
+                    },
+                },
+            },
+        ],
+    },
+    log: {
+        enum: ['info', 'warn', 'error'],
+        description: `Logs its input data (returns it) and its context.
+
+The value to set is the log level.`,
+    },
+};
+//# sourceMappingURL=unsorted.js.map

package/remap.js

@@ -324,7 +324,7 @@ const mapperImplementations = {
     },
     'string.replace'(values, input) {
         const [[regex, replacer]] = Object.entries(values);
-        return String(input).replace(new RegExp(regex, 'gm'), replacer);
+        return String(input).replaceAll(new RegExp(regex, 'gm'), replacer);
     },
     translate(messageId, input, context) {
         const message = context.getMessage({ id: messageId });

package/remap.test.js

@@ -119,7 +119,7 @@ describe('context', () => {
 });
 describe('date.now', () => {
     beforeEach(() => {
-        import.meta.jest.useFakeTimers({ now: 0 });
+        vi.useFakeTimers({ now: 0 });
     });
     runTests({
         'return the current date': {
@@ -131,7 +131,7 @@ describe('date.now', () => {
 });
 describe('date.add', () => {
     beforeEach(() => {
-        import.meta.jest.useFakeTimers({ now: 0 });
+        vi.useFakeTimers({ now: 0 });
     });
     runTests({
         'add 3 days to the given date': {
@@ -187,9 +187,9 @@ describe('date.format', () => {
 });
 describe('log', () => {
     beforeEach(() => {
-        import.meta.jest.spyOn(console, 'error').mockImplementation();
-        import.meta.jest.spyOn(console, 'info').mockImplementation();
-        import.meta.jest.spyOn(console, 'warn').mockImplementation();
+        vi.spyOn(console, 'error').mockImplementation(null);
+        vi.spyOn(console, 'info').mockImplementation(null);
+        vi.spyOn(console, 'warn').mockImplementation(null);
     });
     function runLogTests(tests) {
         it.each(Object.entries(tests))('should %s', (name, { context, expected: expectedInput, history, input, mappers, messages, userInfo }) => {
@@ -870,7 +870,7 @@ describe('random.choice', () => {
 });
 describe('random.integer', () => {
     beforeEach(() => {
-        import.meta.jest.spyOn(Math, 'random').mockReturnValue(0.5);
+        vi.spyOn(Math, 'random').mockReturnValue(0.5);
     });
     runTests({
         'return the input if the input is not an array': {
@@ -882,7 +882,7 @@ describe('random.integer', () => {
 });
 describe('random.float', () => {
     beforeEach(() => {
-        import.meta.jest.spyOn(Math, 'random').mockReturnValue(0.5);
+        vi.spyOn(Math, 'random').mockReturnValue(0.5);
     });
     runTests({
         'return the input if the input is not an array': {
@@ -894,8 +894,7 @@ describe('random.float', () => {
 });
 describe('random.string', () => {
     beforeEach(() => {
-        import.meta.jest
-            .spyOn(Math, 'random')
+        vi.spyOn(Math, 'random')
             .mockReturnValueOnce(0)
             .mockReturnValueOnce(0.4)
             .mockReturnValueOnce(0.5)

package/string.js

@@ -5,7 +5,7 @@
  * @returns The input, but hyphenated.
  */
 export function camelToHyphen(string) {
-    return string.replace(/[A-Z]/g, (match) => `-${match.toLowerCase()}`);
+    return string.replaceAll(/[A-Z]/g, (match) => `-${match.toLowerCase()}`);
 }
 /**
  * Convert a string to upper case.
@@ -25,6 +25,6 @@ export function toUpperCase(input) {
  * @returns The escaped JSON pointer segment.
  */
 export function decodeJSONRef(ref) {
-    return decodeURIComponent(ref).replace(/~1/g, '/').replace(/~0/g, '~');
+    return decodeURIComponent(ref).replaceAll('~1', '/').replaceAll('~0', '~');
 }
 //# sourceMappingURL=string.js.map

package/vitest.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vitest/dist/config.js").UserProjectConfigExport;
+export default _default;