@appsemble/utils 0.34.20 → 0.35.3-test.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.34.20/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.35.3-test.0/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.34.20/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.34.20)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.35.3-test.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.35.3-test.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.34.20/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.35.3-test.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

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

@@ -29,4 +29,5 @@ export * from './seed.js';
 export * from './selectedGroupId.js';
 export * from './webhookName.js';
 export * from './webhookSecretId.js';
+export * from './organizationSubscriptionId.js';
 export * from './delimiter.js';

package/api/components/parameters/index.js

@@ -29,5 +29,6 @@ export * from './seed.js';
 export * from './selectedGroupId.js';
 export * from './webhookName.js';
 export * from './webhookSecretId.js';
+export * from './organizationSubscriptionId.js';
 export * from './delimiter.js';
 //# sourceMappingURL=index.js.map

package/api/components/parameters/organizationSubscriptionId.d.ts

@@ -0,0 +1,9 @@
+export declare const organizationSubscriptionId: {
+    name: string;
+    required: boolean;
+    in: string;
+    description: string;
+    schema: {
+        $ref: string;
+    };
+};

package/api/components/parameters/organizationSubscriptionId.js

@@ -0,0 +1,8 @@
+export const organizationSubscriptionId = {
+    name: 'organizationSubscriptionId',
+    required: true,
+    in: 'path',
+    description: 'The ID of the subscription on which to perform an operation',
+    schema: { $ref: '#/components/schemas/OrganizationSubscription/properties/id' },
+};
+//# sourceMappingURL=organizationSubscriptionId.js.map

package/api/components/responses/organizationSubscription.d.ts

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

package/api/components/responses/organizationSubscription.js

@@ -0,0 +1,11 @@
+export const organizationSubscription = {
+    description: 'A subscription response',
+    content: {
+        'application/json': {
+            schema: {
+                $ref: '#/components/schemas/OrganizationSubscription',
+            },
+        },
+    },
+};
+//# sourceMappingURL=organizationSubscription.js.map

package/api/components/responses/organizationSubscriptionPrice.d.ts

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

package/api/components/responses/organizationSubscriptionPrice.js

@@ -0,0 +1,11 @@
+export const organizationSubscriptionPrice = {
+    description: 'A subscription price response',
+    content: {
+        'application/json': {
+            schema: {
+                $ref: '#/components/schemas/OrganizationSubscriptionPrice',
+            },
+        },
+    },
+};
+//# sourceMappingURL=organizationSubscriptionPrice.js.map

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

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

package/api/components/schemas/AppPaymentSettings.js

@@ -0,0 +1,24 @@
+export const SSLSecret = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'The payment settings of an app.',
+    properties: {
+        stripeApiSecretKey: {
+            type: 'string',
+            description: 'The private API key used for accessing Stripe account connected to the app.',
+        },
+        stripeWebhookSecret: {
+            type: 'string',
+            description: 'The private secret used for authenticating app related Stripe webhooks.',
+        },
+        successUrl: {
+            type: 'string',
+            description: 'The url users are redirected to after successfully completing app related Stripe checkout session.',
+        },
+        cancelUrl: {
+            type: 'string',
+            description: 'The url users are redirected to after unsuccessfully completing app related Stripe checkout session.',
+        },
+    },
+};
+//# sourceMappingURL=AppPaymentSettings.js.map

package/api/components/schemas/Organization.js

@@ -33,6 +33,42 @@ export const Organization = {
             type: 'string',
             description: 'The URL used to fetch the organization’s icon.',
         },
+        preferredPaymentProvider: {
+            type: 'string',
+            description: 'The preferred payment provider of the organization.',
+        },
+        vatIdNumber: {
+            type: 'string',
+            description: 'The VAT id number of the organization.',
+        },
+        streetName: {
+            type: 'string',
+            description: 'Street name that will appear on the invoice.',
+        },
+        houseNumber: {
+            type: 'string',
+            description: 'House number of the organization,',
+        },
+        city: {
+            type: 'string',
+            description: 'City where the organization is located',
+        },
+        zipCode: {
+            type: 'string',
+            description: 'Zip code of the organization',
+        },
+        countryCode: {
+            type: 'string',
+            description: 'Country code of the country where the organization is located',
+        },
+        invoiceReference: {
+            type: 'string',
+            description: 'The reference identifier that will appear on the invoices.',
+        },
+        stripeCustomerId: {
+            type: 'string',
+            description: 'Stripe internal ID of the customer used to match it with the organization in our database.',
+        },
     },
 };
 //# sourceMappingURL=Organization.js.map

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

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

package/api/components/schemas/OrganizationSubscription.js

@@ -0,0 +1,42 @@
+import { normalized } from '../../../constants/index.js';
+export const OrganizationSubscription = {
+    type: 'object',
+    description: 'A subscription holds permission to what the users withing an organization are allowed to do.',
+    required: ['id', 'subscriptionPlan', 'organizationId'],
+    additionalProperties: false,
+    properties: {
+        id: {
+            type: 'number',
+            description: 'The unique identifier for the subscription.',
+        },
+        cancelled: {
+            type: 'boolean',
+            description: 'Whether the subscription will be renewed at the end.',
+        },
+        cancellationReason: {
+            type: 'string',
+            description: 'Users reasoning for cancelling the subscription.',
+        },
+        expirationDate: {
+            type: 'string',
+            description: 'The expiration date of the subscription.',
+            format: 'date-time',
+        },
+        subscriptionPlan: {
+            description: 'The plan associated with the subscription.',
+            enum: ['free', 'premium'],
+        },
+        renewalPeriod: {
+            description: 'The renewal period associated with the subscription.',
+            enum: ['month', 'year'],
+        },
+        organizationId: {
+            type: 'string',
+            pattern: normalized.source,
+            minLength: 1,
+            maxLength: 30,
+            description: 'The unique identifier for the organization.',
+        },
+    },
+};
+//# sourceMappingURL=OrganizationSubscription.js.map

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

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

package/api/components/schemas/OrganizationSubscriptionsPrice.js

@@ -0,0 +1,25 @@
+export const OrganizationSubscriptionPrice = {
+    type: 'object',
+    description: 'A subscription price holds pricing information about the subscription.',
+    required: ['basePrice'],
+    additionalProperties: false,
+    properties: {
+        totalPrice: {
+            type: 'number',
+            description: 'The total price.',
+        },
+        basePrice: {
+            type: 'number',
+            description: 'Base price without VAT',
+        },
+        vatPercentage: {
+            type: 'number',
+            description: 'The VAT that applies to the transaction.',
+        },
+        vatAmount: {
+            type: 'number',
+            description: 'The VAT amount that applies to the transaction.',
+        },
+    },
+};
+//# sourceMappingURL=OrganizationSubscriptionsPrice.js.map

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

@@ -16,6 +16,7 @@ export * from './OrganizationMember.js';
 export * from './OAuth2AuthorizationCode.js';
 export * from './OAuth2ClientCredentials.js';
 export * from './Organization.js';
+export * from './OrganizationSubscription.js';
 export * from './Rating.js';
 export * from './Resource.js';
 export * from './ResourceSubscription.js';

package/api/components/schemas/index.js

@@ -16,6 +16,7 @@ export * from './OrganizationMember.js';
 export * from './OAuth2AuthorizationCode.js';
 export * from './OAuth2ClientCredentials.js';
 export * from './Organization.js';
+export * from './OrganizationSubscription.js';
 export * from './Rating.js';
 export * from './Resource.js';
 export * from './ResourceSubscription.js';

package/api/paths/apps/appId/clonable-assets.js

@@ -0,0 +1,20 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Check if an app has clonable assets.',
+        operationId: 'checkAppClonableAssets',
+        responses: {
+            200: {
+                description: 'Whether the app has clonable assets.',
+                content: {
+                    'application/json': {
+                        schema: { type: 'boolean' },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+};
+//# sourceMappingURL=clonable-assets.js.map

package/api/paths/apps/appId/clonable-resources.js

@@ -0,0 +1,20 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Check if an app has clonable resources.',
+        operationId: 'checkAppClonableResources',
+        responses: {
+            200: {
+                description: 'Whether the app has clonable resources.',
+                content: {
+                    'application/json': {
+                        schema: { type: 'boolean' },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+};
+//# sourceMappingURL=clonable-resources.js.map

package/api/paths/{group-invites → apps/appId/group-invites}/token/respond.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'token',
             in: 'path',

package/api/paths/{group-invites → apps/appId/group-invites}/token.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'token',
             in: 'path',

package/api/paths/{group-members → apps/appId/group-members}/groupMemberId/role.js

@@ -1,5 +1,8 @@
 export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/groupMemberId' }],
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/groupMemberId' },
+    ],
     put: {
         tags: ['common', 'group-member'],
         description: 'Set the role of a member within a group.',

package/api/paths/{group-members → apps/appId/group-members}/groupMemberId.js

@@ -1,5 +1,8 @@
 export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/groupMemberId' }],
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/groupMemberId' },
+    ],
     get: {
         tags: ['common', 'group-member'],
         description: 'Get a certain group member from a group',

package/api/paths/{groups → apps/appId/groups}/groupId/invites/resend.js

@@ -1,5 +1,8 @@
 export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/groupId' }],
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/groupId' },
+    ],
     post: {
         tags: ['group'],
         description: 'Request to resend an invitation.',

package/api/paths/{groups → apps/appId/groups}/groupId/invites.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'groupId',
             in: 'path',

package/api/paths/{groups → apps/appId/groups}/groupId/members.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'groupId',
             in: 'path',

package/api/paths/{groups → apps/appId/groups}/groupId.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'groupId',
             in: 'path',

package/api/paths/{app-invites → apps/appId/invites}/token/respond.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'token',
             in: 'path',

package/api/paths/{app-invites → apps/appId/invites}/token.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'token',
             in: 'path',

package/api/paths/{app-members → apps/appId/members}/appMemberId/picture.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'appMemberId',
             in: 'path',

package/api/paths/apps/appId/members/appMemberId/properties.d.ts

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

package/api/paths/{app-members → apps/appId/members}/appMemberId/properties.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'appMemberId',
             in: 'path',

package/api/paths/apps/appId/members/appMemberId/role.d.ts

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

package/api/paths/{app-members → apps/appId/members}/appMemberId/role.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'appMemberId',
             in: 'path',

package/api/paths/{app-members → apps/appId/members}/appMemberId.js

@@ -1,5 +1,6 @@
 export const pathItems = {
     parameters: [
+        { $ref: '#/components/parameters/appId' },
         {
             name: 'appMemberId',
             in: 'path',

package/api/paths/apps/appId/paymentSettings.d.ts

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

package/api/paths/apps/appId/paymentSettings.js

@@ -0,0 +1,91 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app'],
+        operationId: 'getAppPaymentSettings',
+        description: 'Get app payment settings configuration',
+        responses: {
+            200: {
+                description: 'The app payment configuration',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                stripeApiSecretKey: {
+                                    type: 'boolean',
+                                    description: 'Whether stripe api key is set.',
+                                },
+                                stripeWebhookSecret: {
+                                    type: 'boolean',
+                                    description: 'Whether stripe secret is set.',
+                                },
+                                successUrl: {
+                                    type: 'string',
+                                    description: 'The url users are redirected to after successfully completing app related Stripe checkout session.',
+                                },
+                                cancelUrl: {
+                                    type: 'string',
+                                    description: 'The url users are redirected to after unsuccessfully completing app related Stripe checkout session.',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        parameters: [
+            {
+                in: 'path',
+                name: 'appId',
+                description: 'App that is creating the checkout.',
+                schema: { type: 'number' },
+            },
+        ],
+        security: [{ studio: [] }],
+    },
+    patch: {
+        tags: ['main', 'app'],
+        operationId: 'updateAppPaymentSettings',
+        description: 'Update app payment settings configuration',
+        requestBody: {
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            stripeApiSecretKey: {
+                                type: 'string',
+                                description: 'The private API key used for accessing Stripe account connected to the app.',
+                            },
+                            stripeWebhookSecret: {
+                                type: 'string',
+                                description: 'The private secret used for authenticating app related Stripe webhooks.',
+                            },
+                            successUrl: {
+                                type: 'string',
+                                description: 'The url users are redirected to after successfully completing app related Stripe checkout session.',
+                            },
+                            cancelUrl: {
+                                type: 'string',
+                                description: 'The url users are redirected to after unsuccessfully completing app related Stripe checkout session.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The app payment configuration',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/AppPaymentSettings' },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=paymentSettings.js.map

package/api/paths/apps/appId/payments/acceptPayment.d.ts

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