@appsemble/utils 0.29.10 → 0.30.1

package/api/paths/users/current/apps.d.ts

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

package/api/paths/users/current/apps.js

@@ -0,0 +1,32 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'user', 'current-user', 'app'],
+        parameters: [
+            {
+                name: 'language',
+                schema: { type: 'string' },
+                description: 'The language to include the translations of, if available',
+                in: 'query',
+            },
+        ],
+        description: 'Get all apps that are editable by the user.',
+        operationId: 'queryCurrentUserApps',
+        responses: {
+            200: {
+                description: 'The list of all editable apps.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/App',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=apps.js.map

package/api/paths/users/current/auth/oauth2/apps/appId/consent/agree.d.ts

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

package/api/paths/users/current/auth/oauth2/apps/appId/consent/agree.js

@@ -0,0 +1,12 @@
+export const pathItems = {
+    post: {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        description: 'Create a new OAuth2 consent.',
+        tags: ['main', 'user', 'current-user', 'auth', 'oauth2'],
+        operationId: 'agreeCurrentUserOAuth2AppConsent',
+        requestBody: { $ref: '#/components/requestBodies/oauth2Consent' },
+        responses: { 201: { $ref: '#/components/responses/oauth2AuthorizationCode' } },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=agree.js.map

package/api/paths/users/current/auth/oauth2/apps/appId/consent/verify.d.ts

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

package/api/paths/users/current/auth/oauth2/apps/appId/consent/verify.js

@@ -0,0 +1,12 @@
+export const pathItems = {
+    post: {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        description: 'Verify if the user has previously agreed to the requested OAuth2 consent.',
+        tags: ['main', 'user', 'current-user', 'auth', 'oauth2'],
+        operationId: 'verifyCurrentUserOAuth2AppConsent',
+        requestBody: { $ref: '#/components/requestBodies/oauth2Consent' },
+        responses: { 200: { $ref: '#/components/responses/oauth2AuthorizationCode' } },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=verify.js.map

package/api/paths/users/current/auth/oauth2/authorizations.d.ts

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

package/api/paths/users/current/auth/oauth2/authorizations.js

@@ -0,0 +1,43 @@
+export const pathItems = {
+    get: {
+        description: 'Get a list of the current user’s OAuth2 authorizations.',
+        tags: ['main', 'user', 'current-user', 'auth', 'oauth2', 'authorization'],
+        operationId: 'getCurrentUserOAuth2Authorizations',
+        responses: {
+            200: {
+                description: 'An access token response.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    authorizationUrl: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    delete: {
+        description: 'Unlink a linked account from the logged in user.',
+        tags: ['main', 'user', 'current-user', 'auth', 'oauth2', 'authorization'],
+        operationId: 'deleteCurrentUserOAuth2Authorization',
+        parameters: [
+            { in: 'query', name: 'authorizationUrl', required: true, schema: { type: 'string' } },
+        ],
+        responses: {
+            201: {
+                description: 'The account was unlinked successfully.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=authorizations.js.map

package/api/paths/users/current/auth/oauth2/clientCredentials/clientId.d.ts

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

package/api/paths/users/current/auth/oauth2/clientCredentials/clientId.js

@@ -0,0 +1,23 @@
+export const pathItems = {
+    parameters: [
+        {
+            name: 'clientId',
+            in: 'path',
+            description: 'The client id of the OAuth2 client credentials on which to perform an operation',
+            required: true,
+            schema: { type: 'string' },
+        },
+    ],
+    delete: {
+        description: 'Revoke the client credentials',
+        tags: ['main', 'user', 'current-user', 'auth', 'oauth2', 'client-credentials'],
+        operationId: 'deleteCurrentUserOAuth2ClientCredentials',
+        responses: {
+            204: {
+                description: 'The client credentials have been revoked successfully.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=clientId.js.map

package/api/paths/users/current/auth/oauth2/clientCredentials.d.ts

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

package/api/paths/users/current/auth/oauth2/clientCredentials.js

@@ -0,0 +1,53 @@
+export const pathItems = {
+    post: {
+        description: 'Register new OAuth2 client credentials for the authenticated user.',
+        tags: ['main', 'user', 'current-user', 'auth', 'oauth2', 'client-credentials'],
+        operationId: 'registerCurrentUserOAuth2ClientCredentials',
+        requestBody: {
+            description: 'The OAuth2 client credentials',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/OAuth2ClientCredentials',
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The newly created client credentials',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/OAuth2ClientCredentials',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    get: {
+        description: 'Get a list of client credentials for the authenticated user',
+        tags: ['main', 'user', 'current-user', 'auth', 'oauth2', 'client-credentials'],
+        operationId: 'listCurrentUserOAuth2ClientCredentials',
+        responses: {
+            200: {
+                description: 'A list of client credentials entities.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/OAuth2ClientCredentials',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=clientCredentials.js.map

package/api/paths/users/current/emails.d.ts

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

package/api/paths/users/current/emails.js

@@ -0,0 +1,73 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'user', 'current-user', 'email'],
+        description: "List email addresses registered to logged in user's account.",
+        operationId: 'listCurrentUserEmails',
+        responses: {
+            200: {
+                description: 'The email address has been added successfully.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/UserEmail',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    post: {
+        tags: ['main', 'user', 'current-user', 'email'],
+        description: "Register a new email to logged in user's account.",
+        operationId: 'addCurrentUserEmail',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/UserEmail',
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The email address has been added successfully.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/UserEmail',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    delete: {
+        tags: ['main', 'user', 'current-user', 'email'],
+        description: "Remove an existing email to logged in user's account.",
+        operationId: 'removeCurrentUserEmail',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/UserEmail',
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The email address has been removed successfully.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=emails.js.map

package/api/paths/users/current/organizations.d.ts

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

package/api/paths/users/current/organizations.js

@@ -0,0 +1,29 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'user', 'current-user', 'organization'],
+        description: "Fetch the logged in user's organizations.",
+        operationId: 'getCurrentUserOrganizations',
+        responses: {
+            200: {
+                description: 'The organizations the logged in user is a member of.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    id: { $ref: '#/components/schemas/Organization/properties/id' },
+                                    name: { $ref: '#/components/schemas/Organization/properties/name' },
+                                    role: { $ref: '#/components/schemas/OrganizationMember/properties/role' },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=organizations.js.map

package/api/paths/users/current/unsubscribe.d.ts

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

package/api/paths/users/current/unsubscribe.js

@@ -0,0 +1,29 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'user', 'current-user'],
+        description: 'Unsubscribe a user from the newsletter',
+        operationId: 'unsubscribeCurrentUser',
+        responses: {
+            201: { description: 'Unsubscribed successfully' },
+            401: { description: 'Invalid or missing admin API secret' },
+        },
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=unsubscribe.js.map

package/api/paths/users/current.d.ts

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

package/api/paths/users/current.js

@@ -0,0 +1,43 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'user', 'current-user'],
+        description: "Fetch the logged in user's profile.",
+        operationId: 'getCurrentUser',
+        responses: {
+            200: {
+                description: "The user's profile.",
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/User',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    put: {
+        tags: ['main', 'user', 'current-user'],
+        description: "Update the logged in user's profile.",
+        operationId: 'patchCurrentUser',
+        requestBody: {
+            required: true,
+            $ref: '#/components/requestBodies/user',
+        },
+        responses: {
+            200: {
+                description: "The user's profile.",
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/User',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=current.js.map

package/api/paths/users/subscribed.d.ts

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

package/api/paths/users/subscribed.js

@@ -0,0 +1,12 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'user'],
+        description: 'Get a list of active and verified users subscribed to the appsemble newsletter',
+        operationId: 'getSubscribedUsers',
+        responses: {
+            200: { description: 'List of subscribed users' },
+            401: { description: 'Invalid or missing admin API secret' },
+        },
+    },
+};
+//# sourceMappingURL=subscribed.js.map

package/api/tags/index.d.ts

@@ -1 +1,2 @@
-export declare const tags: import("openapi-types").OpenAPIV3.TagObject[];
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const tags: OpenAPIV3.TagObject[];

package/api/tags/index.js

@@ -1,9 +1,171 @@
-import { app } from './app.js';
-import { asset } from './asset.js';
-import { auth } from './auth.js';
-import { language } from './language.js';
-import { organization } from './organization.js';
-import { resource } from './resource.js';
-import { user } from './user.js';
-export const tags = [app, asset, auth, language, organization, resource, user];
+export const tags = [
+    {
+        name: 'account',
+        description: 'Operations related to app accounts',
+    },
+    {
+        name: 'app-member',
+        description: 'Operations related to app members',
+    },
+    {
+        name: 'app',
+        description: 'Operations related to apps',
+    },
+    {
+        name: 'action',
+        description: 'Operations related to actions',
+    },
+    {
+        name: 'app-collection',
+        description: 'Operations related to app collections',
+    },
+    {
+        name: 'app-definition',
+        description: 'Operations related to the app definitions',
+    },
+    {
+        name: 'asset',
+        description: 'Operations related to assets',
+    },
+    {
+        name: 'auth',
+        description: 'Operations related to authentication',
+    },
+    {
+        name: 'authorization',
+        description: 'Operations related to authorizations',
+    },
+    {
+        name: 'block',
+        description: 'Operations related to blocks',
+    },
+    {
+        name: 'client-credentials',
+        description: 'Operations related to client credentials',
+    },
+    {
+        name: 'common',
+        description: 'Operations shared between apps and the studio',
+    },
+    {
+        name: 'current-member',
+        description: 'Operations related to the currently logged in user',
+    },
+    {
+        name: 'current-user',
+        description: 'Operations related to the currently logged in user',
+    },
+    {
+        name: 'demo-group',
+        description: 'Operations related to demo groups',
+    },
+    {
+        name: 'demo-member',
+        description: 'Operations related to demo members',
+    },
+    {
+        name: 'email',
+        description: 'Operations related to emails',
+    },
+    {
+        name: 'invite',
+        description: 'Operations related to invites.',
+    },
+    {
+        name: 'main',
+        description: 'Operations related to the main api',
+    },
+    {
+        name: 'member',
+        description: 'Operations related to members',
+    },
+    {
+        name: 'oauth2',
+        description: 'Operations related to oauth2',
+    },
+    {
+        name: 'organization',
+        description: 'Operations related to organizations',
+    },
+    {
+        name: 'rating',
+        description: 'Operations related to ratings',
+    },
+    {
+        name: 'readme',
+        description: 'Operations related to readmes',
+    },
+    {
+        name: 'resource',
+        description: 'Operations related to the resources',
+    },
+    {
+        name: 'saml',
+        description: 'Operations related to saml',
+    },
+    {
+        name: 'scim',
+        description: 'Operations related to scim',
+    },
+    {
+        name: 'screenshot',
+        description: 'Operations related to screenshots',
+    },
+    {
+        name: 'secret',
+        description: 'Operations related to secrets',
+    },
+    {
+        name: 'service',
+        description: 'Operations related to service secrets',
+    },
+    {
+        name: 'snapshot',
+        description: 'Operations related to snapshots',
+    },
+    {
+        name: 'ssl',
+        description: 'Operations related to ssl',
+    },
+    {
+        name: 'subscription',
+        description: 'Operations related to subscriptions',
+    },
+    {
+        name: 'group-member',
+        description: 'Operations related to group members',
+    },
+    {
+        name: 'group',
+        description: 'Operations related to groups',
+    },
+    {
+        name: 'template',
+        description: 'Operations related to templates',
+    },
+    {
+        name: 'training',
+        description: 'Operations related to trainings',
+    },
+    {
+        name: 'training-block',
+        description: 'Operations related to training blocks.',
+    },
+    {
+        name: 'translation',
+        description: 'Operations related to translations',
+    },
+    {
+        name: 'user',
+        description: 'Operations related to users.',
+    },
+    {
+        name: 'variable',
+        description: 'Operations related to app variables.',
+    },
+    {
+        name: 'version',
+        description: 'Operations related to versions.',
+    },
+];
 //# sourceMappingURL=index.js.map

package/appMembers.d.ts

@@ -0,0 +1 @@
+export declare function assignAppMemberProperties(properties: any, formData: FormData): void;

package/appMembers.js

@@ -0,0 +1,9 @@
+export function assignAppMemberProperties(properties, formData) {
+    if (properties && typeof properties === 'object' && !Array.isArray(properties)) {
+        formData.append('properties', JSON.stringify(Object.fromEntries(Object.entries(properties).map(([key, value]) => [
+            key,
+            typeof value === 'string' ? value : JSON.stringify(value),
+        ]))));
+    }
+}
+//# sourceMappingURL=appMembers.js.map

package/authorization.d.ts

@@ -0,0 +1,12 @@
+import { type AppDefinition, type AppRole, type CustomAppGuestPermission, type CustomAppPermission, type OrganizationPermission, type PredefinedOrganizationRole, type Security } from '@appsemble/types';
+export declare function getAppInheritedRoles(appSecurityDefinition: Security, roles: AppRole[], accumulatedRoles?: AppRole[]): AppRole[];
+export declare function getAppRolePermissions(appSecurityDefinition: Security, roles: AppRole[]): CustomAppPermission[];
+export declare function getGuestAppPermissions(appSecurityDefinition: Security): CustomAppPermission[];
+export declare function checkGuestAppPermissions(appSecurityDefinition: Security, requiredPermissions: CustomAppPermission[]): boolean;
+export declare function getAppRoles(appSecurityDefinition: Security): AppRole[];
+export declare function getAppPossibleGuestPermissions(appDefinition: AppDefinition): CustomAppGuestPermission[];
+export declare function getAppPossiblePermissions(appDefinition: AppDefinition): CustomAppPermission[];
+export declare function getAppRolesByPermissions(appSecurityDefinition: Security, requiredPermissions: CustomAppPermission[]): (AppRole | 'Guest')[];
+export declare function checkAppRoleAppPermissions(appSecurityDefinition: Security, appRole: string, requiredPermissions: CustomAppPermission[]): boolean;
+export declare function checkOrganizationRoleAppPermissions(organizationRole: PredefinedOrganizationRole, requiredPermissions: CustomAppPermission[]): boolean;
+export declare function checkOrganizationRoleOrganizationPermissions(organizationRole: PredefinedOrganizationRole, requiredPermissions: OrganizationPermission[]): boolean;