@appsemble/types 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 Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.35.3-test.0/config/assets/logo.svg) Appsemble Types
 
 > Reusable TypeScript types
 
 [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
-[![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/cli.d.ts

@@ -143,6 +143,22 @@ export interface AppsembleContext {
      * line.
      */
     assetsClonable?: boolean;
+    /**
+     * The name of the external app database.
+     */
+    dbName?: string;
+    /**
+     * The host of the external app database.
+     */
+    dbHost?: string;
+    /**
+     * The port of the external app database.
+     */
+    dbPort?: string;
+    /**
+     * The user of the external app database.
+     */
+    dbUser?: string;
 }
 export interface AppsembleRC {
     /**

package/index.d.ts

@@ -20,6 +20,7 @@ export * from './training.js';
 export * from './quota.js';
 export * from './permissions.js';
 export * from './roles.js';
+export * from './subscriptionPlans.js';
 export type { AppMemberInfo };
 export type { ProjectImplementations, BlockManifest, ProjectManifest, ActionType, EventType };
 /**
@@ -125,6 +126,45 @@ export interface TokenResponse {
     refresh_token?: string;
     token_type: 'bearer';
 }
+/**
+ * A type to represent different subscription plans.
+ */
+export declare enum SubscriptionPlanType {
+    Free = "free",
+    Basic = "basic",
+    Standard = "standard",
+    Extensive = "extensive",
+    Enterprise = "enterprise"
+}
+/**
+ * A type to represent different payment statuses for invoice.
+ */
+export declare enum InvoiceStatus {
+    Paid = "paid",
+    Pending = "pending",
+    Retry = "retry",
+    Failed = "failed"
+}
+/**
+ * A type to represent different payment providers.
+ */
+export declare enum PaymentProvider {
+    Stripe = "stripe"
+}
+/**
+ * A type to represent different payment methods.
+ */
+export declare enum PaymentMethod {
+    Debit = "sepa_debit",
+    Card = "card"
+}
+/**
+ * A type to represent different subscription renewal periods.
+ */
+export declare enum SubscriptionRenewalPeriod {
+    Month = "month",
+    Year = "year"
+}
 /**
  * A type to represent the app lock.
  */
@@ -242,14 +282,6 @@ export interface App {
          */
         average: number;
     };
-    /**
-     * Whether the app has clonable resources.
-     */
-    hasClonableResources?: boolean;
-    /**
-     * Whether the app has clonable assets.
-     */
-    hasClonableAssets?: boolean;
     /**
      * A list of URLs to app screenshots
      */
@@ -316,6 +348,22 @@ export interface App {
      * The version of the app.
      */
     version?: number;
+    /**
+     * The name of the app database.
+     */
+    dbName: string;
+    /**
+     * The host of the app database.
+     */
+    dbHost: string;
+    /**
+     * The port of the app database.
+     */
+    dbPort: number;
+    /**
+     * The user of the app database.
+     */
+    dbUser: string;
 }
 /**
  * A rating given to an app.
@@ -376,6 +424,73 @@ export interface Organization {
      * The URL at which the organization’s icon can be found.
      */
     iconUrl: string;
+    /**
+     * The preferred payment provider of the organization.
+     */
+    preferredPaymentProvider: PaymentProvider;
+    /**
+     * The vat id number of the organization.
+     */
+    vatIdNumber: string;
+    /**
+     * The street name of the organization.
+     */
+    streetName: string;
+    /**
+     * The house number of the organization.
+     */
+    houseNumber: string;
+    /**
+     * The city of the organization.
+     */
+    city: string;
+    /**
+     * The zip code of the organization.
+     */
+    zipCode: string;
+    /**
+     * The country code of the organization.
+     */
+    countryCode: string;
+    /**
+     * The reference to be shown on invoices of the organization.
+     */
+    invoiceReference: string;
+}
+/**
+ * A subscription owned by an organization.
+ */
+export interface OrganizationSubscription {
+    /**
+     * The ID of the subscription.
+     */
+    id: number;
+    /**
+     * The status of the subscription.
+     */
+    cancelled: boolean;
+    /**
+     * The reason for cancelling the subscription.
+     */
+    cancellationReason: string;
+    /**
+     * The date until which the subscription has been paid for.
+     */
+    expirationDate: string;
+    /**
+     * The associated subscription plan.
+     */
+    subscriptionPlan: SubscriptionPlanType;
+    /**
+     * The associated renewal period plan.
+     */
+    renewalPeriod: SubscriptionRenewalPeriod;
+    /**
+     * The ID of the organization that owns the subscription.
+     *
+     * This typically is prepended with an `@`
+     */
+    organizationId: string;
 }
 /**
  * An invite for an organization.

package/index.js

@@ -16,8 +16,53 @@ export * from './training.js';
 export * from './quota.js';
 export * from './permissions.js';
 export * from './roles.js';
+export * from './subscriptionPlans.js';
 const assertAppMemberInfoIsBaseUserInfo = true;
 // eslint-disable-next-line @typescript-eslint/no-unused-expressions
 assertAppMemberInfoIsBaseUserInfo;
+/**
+ * A type to represent different subscription plans.
+ */
+export var SubscriptionPlanType;
+(function (SubscriptionPlanType) {
+    SubscriptionPlanType["Free"] = "free";
+    SubscriptionPlanType["Basic"] = "basic";
+    SubscriptionPlanType["Standard"] = "standard";
+    SubscriptionPlanType["Extensive"] = "extensive";
+    SubscriptionPlanType["Enterprise"] = "enterprise";
+})(SubscriptionPlanType || (SubscriptionPlanType = {}));
+/**
+ * A type to represent different payment statuses for invoice.
+ */
+export var InvoiceStatus;
+(function (InvoiceStatus) {
+    InvoiceStatus["Paid"] = "paid";
+    InvoiceStatus["Pending"] = "pending";
+    InvoiceStatus["Retry"] = "retry";
+    InvoiceStatus["Failed"] = "failed";
+})(InvoiceStatus || (InvoiceStatus = {}));
+/**
+ * A type to represent different payment providers.
+ */
+export var PaymentProvider;
+(function (PaymentProvider) {
+    PaymentProvider["Stripe"] = "stripe";
+})(PaymentProvider || (PaymentProvider = {}));
+/**
+ * A type to represent different payment methods.
+ */
+export var PaymentMethod;
+(function (PaymentMethod) {
+    PaymentMethod["Debit"] = "sepa_debit";
+    PaymentMethod["Card"] = "card";
+})(PaymentMethod || (PaymentMethod = {}));
+/**
+ * A type to represent different subscription renewal periods.
+ */
+export var SubscriptionRenewalPeriod;
+(function (SubscriptionRenewalPeriod) {
+    SubscriptionRenewalPeriod["Month"] = "month";
+    SubscriptionRenewalPeriod["Year"] = "year";
+})(SubscriptionRenewalPeriod || (SubscriptionRenewalPeriod = {}));
 export const resourceSubscribableAction = ['create', 'update', 'delete'];
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.34.20",
+  "version": "0.35.3-test.0",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -40,7 +40,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.34.20",
+    "@appsemble/lang-sdk": "0.35.3-test.0",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "jsonschema": "~1.4.1",
     "openapi-types": "^12.0.0",

package/permissions.d.ts

@@ -266,7 +266,15 @@ export declare enum OrganizationPermission {
     /**
      * The permission to send manual push notifications for an app.
      */
-    PushAppNotifications = 65
+    PushAppNotifications = 65,
+    /**
+     * The permission to manage organization subscriptions.
+     */
+    ManageOrganizationSubscriptions = 66,
+    /**
+     * The permission to query organization subscriptions.
+     */
+    QueryOrganizationSubscriptions = 67
 }
 export declare const appOrganizationPermissionMapping: {
     [key in AppPermission]: OrganizationPermission;

package/permissions.js

@@ -268,6 +268,14 @@ export var OrganizationPermission;
      * The permission to send manual push notifications for an app.
      */
     OrganizationPermission[OrganizationPermission["PushAppNotifications"] = 65] = "PushAppNotifications";
+    /**
+     * The permission to manage organization subscriptions.
+     */
+    OrganizationPermission[OrganizationPermission["ManageOrganizationSubscriptions"] = 66] = "ManageOrganizationSubscriptions";
+    /**
+     * The permission to query organization subscriptions.
+     */
+    OrganizationPermission[OrganizationPermission["QueryOrganizationSubscriptions"] = 67] = "QueryOrganizationSubscriptions";
 })(OrganizationPermission || (OrganizationPermission = {}));
 export const appOrganizationPermissionMapping = {
     [AppPermission.CreateAppInvites]: OrganizationPermission.CreateAppInvites,

package/roles.js

@@ -2,6 +2,7 @@ import { OrganizationPermission } from './permissions.js';
 const OrganizationMemberPermissions = [
     OrganizationPermission.QueryApps,
     OrganizationPermission.QueryOrganizationMembers,
+    OrganizationPermission.QueryOrganizationSubscriptions,
 ];
 const OrganizationAppTranslatorPermissions = [
     ...OrganizationMemberPermissions,
@@ -102,6 +103,7 @@ const OrganizationOwnerPermissions = [
     OrganizationPermission.DeleteOrganizations,
     OrganizationPermission.RemoveOrganizationMembers,
     OrganizationPermission.UpdateOrganizationMemberRoles,
+    OrganizationPermission.ManageOrganizationSubscriptions,
 ];
 export var PredefinedOrganizationRole;
 (function (PredefinedOrganizationRole) {

package/subscriptionPlans.d.ts

@@ -0,0 +1,45 @@
+export interface SubscriptionPlan {
+    /**
+     * The name of the Subscription plan.
+     */
+    name: string;
+    /**
+     * The price of the Subscription plan.
+     */
+    price: string;
+    /**
+     * Amount of apps the user can publish.
+     */
+    appLimit: number;
+    /**
+     * How many notifications we allow organizations on this plan to send daily
+     * from our SMTP server. Unlimited with their custom server.
+     */
+    dailyNotifications: number | 'unlimited';
+    /**
+     * How many GB of data we allow the organization to store on our servers.
+     */
+    persistentStorage: number;
+    /**
+     * Whether we allow the organizations to use custom containers.
+     */
+    customContainers: boolean;
+    /**
+     * Service level agreement associated with this plan.
+     */
+    sla: string;
+    /**
+     * Level of block support included in the plan.
+     */
+    blocks: string;
+    /**
+     * Type of backend support included in the plan.
+     */
+    backend: string;
+}
+export declare const freePlan: SubscriptionPlan;
+export declare const basicPlan: SubscriptionPlan;
+export declare const standardPlan: SubscriptionPlan;
+export declare const extensivePlan: SubscriptionPlan;
+export declare const enterprisePlan: SubscriptionPlan;
+export declare function getSubscriptionPlanByName(name: string): SubscriptionPlan;

package/subscriptionPlans.js

@@ -0,0 +1,71 @@
+export const freePlan = {
+    name: 'free',
+    blocks: 'Appsemble supported basic blocks',
+    backend: 'Standard Appsemble backend',
+    price: '0',
+    appLimit: 3,
+    dailyNotifications: 50,
+    persistentStorage: 1,
+    customContainers: false,
+    sla: 'none',
+};
+export const basicPlan = {
+    name: 'basic',
+    blocks: 'Appsemble supported basic blocks',
+    backend: 'Standard Appsemble backend',
+    price: '5',
+    appLimit: Number.POSITIVE_INFINITY,
+    dailyNotifications: 50,
+    persistentStorage: 1,
+    customContainers: false,
+    sla: 'basic',
+};
+export const standardPlan = {
+    name: 'standard',
+    blocks: 'Appsemble supported basic blocks',
+    backend: 'Standard Appsemble backend',
+    price: '25',
+    appLimit: Number.POSITIVE_INFINITY,
+    dailyNotifications: 5000,
+    persistentStorage: 50,
+    customContainers: false,
+    sla: 'standard',
+};
+export const extensivePlan = {
+    name: 'extensive',
+    blocks: '3rd party building blocks',
+    backend: 'Standard Appsemble backend',
+    price: '50',
+    appLimit: Number.POSITIVE_INFINITY,
+    dailyNotifications: Number.POSITIVE_INFINITY,
+    persistentStorage: 200,
+    customContainers: true,
+    sla: 'extensive',
+};
+export const enterprisePlan = {
+    name: 'enterprise',
+    blocks: '3rd party building blocks',
+    backend: 'Hosting of custom backends',
+    price: '100',
+    appLimit: Number.POSITIVE_INFINITY,
+    dailyNotifications: Number.POSITIVE_INFINITY,
+    persistentStorage: 500,
+    customContainers: true,
+    sla: 'enterprise',
+};
+export function getSubscriptionPlanByName(name) {
+    if (basicPlan.name === name) {
+        return basicPlan;
+    }
+    if (standardPlan.name === name) {
+        return standardPlan;
+    }
+    if (extensivePlan.name === name) {
+        return extensivePlan;
+    }
+    if (enterprisePlan.name === name) {
+        return enterprisePlan;
+    }
+    return freePlan;
+}
+//# sourceMappingURL=subscriptionPlans.js.map