@appsemble/utils 0.20.45 → 0.21.0

package/api/components/schemas/index.d.ts

@@ -89,6 +89,9 @@ export * from './SecurityDefaultDefinition.js';
 export * from './SecurityDefinition.js';
 export * from './SecurityRoleDefinition.js';
 export * from './ShareActionDefinition.js';
+export * from './ScimPatchOp.js';
+export * from './ScimSecret.js';
+export * from './ScimUser.js';
 export * from './SSLSecret.js';
 export * from './SSOConfiguration.js';
 export * from './StaticActionDefinition.js';

package/api/components/schemas/index.js

@@ -89,6 +89,9 @@ export * from './SecurityDefaultDefinition.js';
 export * from './SecurityDefinition.js';
 export * from './SecurityRoleDefinition.js';
 export * from './ShareActionDefinition.js';
+export * from './ScimPatchOp.js';
+export * from './ScimSecret.js';
+export * from './ScimUser.js';
 export * from './SSLSecret.js';
 export * from './SSOConfiguration.js';
 export * from './StaticActionDefinition.js';

package/api/components/securitySchemes/index.d.ts

@@ -1,4 +1,5 @@
 export * from './app.js';
 export * from './basic.js';
 export * from './cli.js';
+export * from './scim.js';
 export * from './studio.js';

package/api/components/securitySchemes/index.js

@@ -1,5 +1,6 @@
 export * from './app.js';
 export * from './basic.js';
 export * from './cli.js';
+export * from './scim.js';
 export * from './studio.js';
 //# sourceMappingURL=index.js.map

package/api/components/securitySchemes/scim.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const scim: OpenAPIV3.HttpSecurityScheme;

package/api/components/securitySchemes/scim.js

@@ -0,0 +1,6 @@
+export const scim = {
+    type: 'http',
+    scheme: 'bearer',
+    description: 'Used SCIM clients',
+};
+//# sourceMappingURL=scim.js.map

package/api/index.test.js

@@ -89,7 +89,7 @@ describe('schemas', () => {
             expect(schema).not.toHaveProperty('uniqueItems');
             if (schema.required && !schema.additionalProperties) {
                 for (const name of schema.required) {
-                    // eslint-disable-next-line jest/no-conditional-expect
+                    // eslint-disable-next-line vitest/no-conditional-expect
                     expect(schema.properties).toHaveProperty(name);
                 }
             }

package/api/paths/appScimEndpoints.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const paths: OpenAPIV3.PathsObject;

package/api/paths/appScimEndpoints.js

@@ -0,0 +1,260 @@
+export const paths = {
+    '/api/apps/{appId}/scim/Schemas': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        get: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'getSCIMSchemas',
+            responses: {
+                200: {
+                    description: 'The SCIM Schema',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                                $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    '/api/apps/{appId}/scim/Schemas/{schemaId}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { name: 'schemaId', in: 'path', schema: { type: 'string' } },
+        ],
+        get: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'getSCIMSchema',
+            responses: {
+                200: {
+                    description: 'The SCIM Schema',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                                $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    '/api/apps/{appId}/scim/ResourceTypes': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        get: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'getSCIMResourceTypes',
+            responses: {
+                200: {
+                    description: 'SCIM user',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                            // XXX
+                            // $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    '/api/apps/{appId}/scim/ResourceTypes/{resourceTypeId}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { name: 'resourceTypeId', in: 'path', schema: { type: 'string' } },
+        ],
+        get: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'getSCIMResourceType',
+            responses: {
+                200: {
+                    description: 'SCIM user',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                            // XXX
+                            // $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    '/api/apps/{appId}/scim/ServiceProviderConfig': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        get: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'getSCIMServiceProviderConfig',
+            responses: {
+                200: {
+                    description: 'SCIM user',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                            // XXX
+                            // $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    '/api/apps/{appId}/scim/Users': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        post: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'createSCIMUser',
+            requestBody: {
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            additionalProperties: true,
+                        },
+                    },
+                    'application/scim+json': {
+                        schema: {
+                            type: 'object',
+                            additionalProperties: true,
+                        },
+                    },
+                },
+            },
+            responses: {
+                201: {
+                    description: 'Integrated SCIM user schema',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                                $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        get: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'getSCIMUsers',
+            parameters: [
+                { name: 'count', in: 'query', schema: { type: 'number' } },
+                { name: 'startIndex', in: 'query', schema: { type: 'number' } },
+            ],
+            responses: {
+                200: {
+                    description: 'SCIM user',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                                $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    '/api/apps/{appId}/scim/Users/{userId}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            {
+                name: 'userId',
+                in: 'path',
+                description: 'The ID of the member to perform the operation on',
+                required: true,
+                schema: { $ref: '#/components/schemas/User/properties/id' },
+            },
+        ],
+        get: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'getSCIMUser',
+            responses: {
+                200: {
+                    description: 'SCIM user',
+                    content: {
+                        'application/scim+json': {
+                            schema: {
+                                $ref: '#/components/schemas/ScimUser',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        delete: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'deleteSCIMUser',
+            responses: {
+                204: {
+                    description: 'SCIM user',
+                },
+            },
+        },
+        put: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'updateSCIMUser',
+            requestBody: {
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            additionalProperties: true,
+                        },
+                    },
+                    'application/scim+json': {
+                        schema: {
+                            type: 'object',
+                            additionalProperties: true,
+                        },
+                    },
+                },
+            },
+            responses: {
+                200: {
+                    description: 'SCIM user',
+                },
+            },
+        },
+        patch: {
+            tags: ['scim'],
+            security: [{ scim: [] }],
+            operationId: 'patchSCIMUser',
+            requestBody: {
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            additionalProperties: true,
+                        },
+                    },
+                    'application/scim+json': {
+                        schema: {
+                            type: 'object',
+                            additionalProperties: true,
+                        },
+                    },
+                },
+            },
+            responses: {
+                200: {
+                    description: 'SCIM user',
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=appScimEndpoints.js.map

package/api/paths/appScimSecrets.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const paths: OpenAPIV3.PathsObject;

package/api/paths/appScimSecrets.js

@@ -0,0 +1,45 @@
+export const paths = {
+    '/api/apps/{appId}/secrets/scim': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        get: {
+            tags: ['secret'],
+            operationId: 'getAppScimSecret',
+            description: 'Get app SCIM secret configuration',
+            security: [{ studio: [] }],
+            responses: {
+                200: {
+                    description: 'The app SCIM configuration',
+                    content: {
+                        'application/json': {
+                            schema: { $ref: '#/components/schemas/ScimSecret' },
+                        },
+                    },
+                },
+            },
+        },
+        patch: {
+            tags: ['secret'],
+            operationId: 'updateAppScimSecret',
+            description: 'Update app SCIM secret configuration',
+            requestBody: {
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/ScimSecret' },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+            responses: {
+                200: {
+                    description: 'The app SCIM configuration',
+                    content: {
+                        'application/json': {
+                            schema: { $ref: '#/components/schemas/ScimSecret' },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=appScimSecrets.js.map

package/api/paths/index.js

@@ -3,6 +3,8 @@ import { paths as translations } from './appMessages.js';
 import { paths as appOAuth2Secrets } from './appOAuth2Secrets.js';
 import { paths as apps } from './apps.js';
 import { paths as appSamlSecrets } from './appSamlSecrets.js';
+import { paths as scimEndpoints } from './appScimEndpoints.js';
+import { paths as appScimSecrets } from './appScimSecrets.js';
 import { paths as appsembleMessages } from './appsembleMessages.js';
 import { paths as appServiceSecrets } from './appServiceSecrets.js';
 import { paths as appSSLSecrets } from './appSSLSecrets.js';
@@ -24,6 +26,8 @@ export const paths = {
     ...appOAuth2Secrets,
     ...apps,
     ...appSamlSecrets,
+    ...appScimSecrets,
+    ...scimEndpoints,
     ...appsembleMessages,
     ...appSSLSecrets,
     ...assets,

package/appMessages.test.js

@@ -396,7 +396,7 @@ describe('extractAppMessages', () => {
         expect(result).toMatchObject({ app: { 'pages.tabs': 'Tabs', 'pages.tabs.tabs.0': 'Tab' } });
     });
     it('should append any messages returned by onBlock', () => {
-        const onBlock = import.meta.jest.fn().mockReturnValue({ foo: 'bar' });
+        const onBlock = vi.fn().mockReturnValue({ foo: 'bar' });
         const result = extractAppMessages({
             defaultPage: '',
             pages: [{ name: 'Page', blocks: [{ type: '', version: '' }] }],

package/iterApp.test.js

@@ -1,8 +1,8 @@
 import { iterAction, iterApp, iterBlock, iterBlockList, iterPage } from './iterApp.js';
 describe('iterAction', () => {
     it('should call the appropriate callbacks', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'dialog',
             blocks: [{ type: 'list', version: '0.1.2' }],
@@ -13,8 +13,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should abort if the onAction callback returns true', () => {
-        const onAction = import.meta.jest.fn().mockReturnValue(true);
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn().mockReturnValue(true);
+        const onBlockList = vi.fn();
         const action = {
             type: 'dialog',
             blocks: [{ type: 'list', version: '0.1.2' }],
@@ -25,8 +25,8 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should call onAction for onSuccess', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onSuccess: {
@@ -40,10 +40,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should return true if onAction returns true for onSuccess', () => {
-        const onAction = import.meta.jest
-            .fn()
-            .mockImplementation((a, [prefix]) => prefix === 'onSuccess');
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn().mockImplementation((a, [prefix]) => prefix === 'onSuccess');
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onSuccess: {
@@ -57,8 +55,8 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should call onAction for onError', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onError: {
@@ -72,10 +70,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should return true if onAction returns true for onError', () => {
-        const onAction = import.meta.jest
-            .fn()
-            .mockImplementation((a, [prefix]) => prefix === 'onError');
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn().mockImplementation((a, [prefix]) => prefix === 'onError');
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onError: {
@@ -89,7 +85,7 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should call then and else for conditional actions', () => {
-        const onAction = import.meta.jest.fn();
+        const onAction = vi.fn();
         const action = {
             type: 'condition',
             if: true,
@@ -103,8 +99,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should return the return value of iterBlockList', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn().mockReturnValue(true);
+        const onAction = vi.fn();
+        const onBlockList = vi.fn().mockReturnValue(true);
         const action = {
             type: 'dialog',
             blocks: [{ type: 'list', version: '0.1.2' }],
@@ -118,8 +114,8 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should not call iterBlockList if the action has no blocks', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'log',
         };
@@ -134,8 +130,8 @@ describe('iterAction', () => {
 });
 describe('iterBlock', () => {
     it('should call the appropriate callbacks', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlock = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlock = vi.fn();
         const block = {
             type: 'list',
             version: '1.2.3',
@@ -151,8 +147,8 @@ describe('iterBlock', () => {
         expect(result).toBe(false);
     });
     it('should abort if onBlock returns true', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlock = import.meta.jest.fn().mockReturnValue(true);
+        const onAction = vi.fn();
+        const onBlock = vi.fn().mockReturnValue(true);
         const block = {
             type: 'list',
             version: '1.2.3',
@@ -168,8 +164,8 @@ describe('iterBlock', () => {
         expect(result).toBe(true);
     });
     it('should return the return value of onAction', () => {
-        const onAction = import.meta.jest.fn().mockReturnValue(true);
-        const onBlock = import.meta.jest.fn();
+        const onAction = vi.fn().mockReturnValue(true);
+        const onBlock = vi.fn();
         const block = {
             type: 'list',
             version: '1.2.3',
@@ -187,8 +183,8 @@ describe('iterBlock', () => {
 });
 describe('iterBlockList', () => {
     it('should call the appropriate callbacks', () => {
-        const onBlock = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onBlock = vi.fn();
+        const onBlockList = vi.fn();
         const blocks = [
             {
                 type: 'list',
@@ -206,8 +202,8 @@ describe('iterBlockList', () => {
         expect(result).toBe(false);
     });
     it('should abort if onBlockList returns true', () => {
-        const onBlock = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn().mockReturnValue(true);
+        const onBlock = vi.fn();
+        const onBlockList = vi.fn().mockReturnValue(true);
         const blocks = [
             {
                 type: 'list',
@@ -227,8 +223,8 @@ describe('iterBlockList', () => {
 });
 describe('iterPage', () => {
     it('should iterate over a page', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onBlockList = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             blocks: [],
@@ -239,8 +235,8 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should abort if onPage returns true', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn().mockReturnValue(true);
+        const onBlockList = vi.fn();
+        const onPage = vi.fn().mockReturnValue(true);
         const page = {
             name: 'Page',
             blocks: [],
@@ -251,8 +247,8 @@ describe('iterPage', () => {
         expect(result).toBe(true);
     });
     it('should iterate a flow page', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onBlockList = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             type: 'flow',
@@ -269,8 +265,8 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should iterate a tabs page', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onBlockList = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             type: 'tabs',
@@ -287,8 +283,8 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should call onAction for page actions', () => {
-        const onAction = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             type: 'flow',
@@ -305,9 +301,9 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should call onAction and onBlockList for pages with actions and sub pages', () => {
-        const onAction = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onPage = vi.fn();
+        const onBlockList = vi.fn();
         const page = {
             name: 'Page',
             type: 'flow',
@@ -342,7 +338,7 @@ describe('iterPage', () => {
 });
 describe('iterApp', () => {
     it('should iterate over the page of an app', () => {
-        const onPage = import.meta.jest.fn();
+        const onPage = vi.fn();
         const app = {
             name: 'App',
             defaultPage: 'Page',
@@ -358,7 +354,7 @@ describe('iterApp', () => {
         expect(result).toBe(false);
     });
     it('should abort page iteration if a callback returns true', () => {
-        const onPage = import.meta.jest.fn().mockReturnValue(true);
+        const onPage = vi.fn().mockReturnValue(true);
         const app = {
             name: 'App',
             defaultPage: 'Page 1',
@@ -379,7 +375,7 @@ describe('iterApp', () => {
         expect(result).toBe(true);
     });
     it('should iterate over cron jobs', () => {
-        const onAction = import.meta.jest.fn();
+        const onAction = vi.fn();
         const app = {
             name: 'App',
             defaultPage: 'Page 1',
@@ -396,7 +392,7 @@ describe('iterApp', () => {
         expect(result).toBe(false);
     });
     it('should abort cron iteration if a callback returns true', () => {
-        const onAction = import.meta.jest.fn().mockReturnValue(true);
+        const onAction = vi.fn().mockReturnValue(true);
         const app = {
             name: 'App',
             defaultPage: 'Page 1',