@appsemble/utils 0.20.44 → 0.21.0

package/api/components/schemas/ScimUser.js

@@ -0,0 +1,60 @@
+export const ScimUser = {
+    type: 'object',
+    additionalProperties: true,
+    description: 'The definition of a user according to the SCIM documentation.',
+    required: ['emails', 'schemas', 'userName'],
+    properties: {
+        schemas: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        userName: {
+            type: 'string',
+            description: 'A unique identifier for the user (generally maps to the Azure AD user principal name)',
+        },
+        active: {
+            type: 'boolean',
+        },
+        meta: {
+            type: 'object',
+            additionalProperties: false,
+            description: 'Read-only metadata maintained by the service provider',
+            properties: {
+                resourceType: {
+                    type: 'string',
+                },
+                created: {
+                    type: 'string',
+                },
+                lastModified: {
+                    type: 'string',
+                },
+                location: {
+                    type: 'string',
+                },
+            },
+        },
+        emails: {
+            type: 'array',
+            minLength: 1,
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                description: "A user's email. By default, one of these should be of type 'work' and have 'primary' set to true. Value contains actual address",
+                required: ['primary', 'type', 'value'],
+                properties: {
+                    primary: {
+                        type: 'boolean',
+                    },
+                    type: {
+                        type: 'string',
+                    },
+                    value: {
+                        type: 'string',
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=ScimUser.js.map

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

@@ -0,0 +1 @@
+export declare const TeamMembersActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/TeamMembersActionDefinition.js

@@ -0,0 +1,18 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const TeamMembersActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'id'],
+    properties: {
+        type: {
+            enum: ['team.members'],
+            description: "Get a list of a team's members",
+        },
+        id: {
+            description: 'The ID of a specific team to get the members from',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+    },
+});
+//# sourceMappingURL=TeamMembersActionDefinition.js.map

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';
@@ -103,6 +106,7 @@ export * from './TabsPageDefinition.js';
 export * from './TeamInviteActionDefinition.js';
 export * from './TeamJoinActionDefinition.js';
 export * from './TeamListActionDefinition.js';
+export * from './TeamMembersActionDefinition.js';
 export * from './TeamsDefinition.js';
 export * from './Theme.js';
 export * from './ThrowActionDefinition.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';
@@ -103,6 +106,7 @@ export * from './TabsPageDefinition.js';
 export * from './TeamInviteActionDefinition.js';
 export * from './TeamJoinActionDefinition.js';
 export * from './TeamListActionDefinition.js';
+export * from './TeamMembersActionDefinition.js';
 export * from './TeamsDefinition.js';
 export * from './Theme.js';
 export * from './ThrowActionDefinition.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.d.ts

@@ -1,7 +1,24 @@
 import { type OpenAPIV3 } from 'openapi-types';
 export * as schemas from './components/schemas/index.js';
 interface APIParams {
+    /**
+     * The port on which the server runs.
+     */
     port?: number;
+    /**
+     * The host on which the server is exposed.
+     */
     host?: string;
+    /**
+     * Whether or not the API is served using SSL.
+     */
+    ssl?: boolean;
 }
-export declare function api(version: string, { port, host }?: APIParams): OpenAPIV3.Document;
+/**
+ * Get the OpenAPI document for the Appsemble REST API.
+ *
+ * @param version The Appsemble version
+ * @param argv The parsed command line arguments.
+ * @returns The OpenAPI document for Appsemble.
+ */
+export declare function api(version: string, { port, ssl, host }?: APIParams): OpenAPIV3.Document;

package/api/index.js

@@ -2,7 +2,14 @@ import { components } from './components/index.js';
 import { paths } from './paths/index.js';
 import { tags } from './tags/index.js';
 export * as schemas from './components/schemas/index.js';
-export function api(version, { port = 9999, host = `http://localhost:${port}` } = {}) {
+/**
+ * Get the OpenAPI document for the Appsemble REST API.
+ *
+ * @param version The Appsemble version
+ * @param argv The parsed command line arguments.
+ * @returns The OpenAPI document for Appsemble.
+ */
+export function api(version, { port = 9999, ssl, host = `${ssl ? 'https' : 'http'}://localhost:${port}` } = {}) {
     return {
         openapi: '3.0.2',
         components,

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/apps.js

@@ -1167,7 +1167,7 @@ This will return a 404 if the user has not uploaded one.`,
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, { app: ['teams:read'] }],
         },
         post: {
             tags: ['app'],
@@ -1221,6 +1221,23 @@ This will return a 404 if the user has not uploaded one.`,
                 schema: { $ref: '#/components/schemas/User/properties/id' },
             },
         ],
+        get: {
+            tags: ['app'],
+            description: 'Get a certain team member from a team',
+            operationId: 'getTeamMember',
+            responses: {
+                200: {
+                    description: 'The specified team member',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                $ref: '#/components/schemas/Member',
+                            },
+                        },
+                    },
+                },
+            },
+        },
         put: {
             tags: ['app'],
             description: 'Update the role of a team member.',

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: '' }] }],