@brimble/models 3.8.156 → 4.0.0

package/dist/types/ownership-transfer.d.ts

@@ -1,10 +1,11 @@
 import { Document } from "mongoose";
 import { ITeam } from "./team";
 import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IOwnershipTransfer extends Document {
-    team: ITeam;
-    from_user: IUser;
-    to_user: IUser;
+    team: Ref<ITeam>;
+    from_user: Ref<IUser>;
+    to_user: Ref<IUser>;
     status: "pending" | "accepted" | "denied" | "expired";
     expires_at: Date;
     created_at: Date;

package/dist/types/permission.d.ts

@@ -1,9 +1,10 @@
 import { Document } from "mongoose";
 import { IRole } from "./role";
 import { PERMISSION_TYPE, REQUEST_TYPE } from "../enum";
+import { Ref } from "./ref";
 export interface IPermission extends Document {
     title: string;
-    role: IRole[];
+    role: Ref<IRole>[];
     type: PERMISSION_TYPE;
     request: {
         route: string;

package/dist/types/plan_configuration.d.ts

@@ -1,10 +1,11 @@
 import { Document } from "mongoose";
 import { SUBSCRIPTION_PLAN_TYPE } from "../enum";
 import { IRegion } from "./region";
+import { Ref } from "./ref";
 export interface IPlanConfiguration extends Document {
     tag: string;
     price: number;
-    region: IRegion;
+    region: Ref<IRegion>;
     alerting: boolean;
     drain: boolean;
     slack_support: boolean;

package/dist/types/platform-api-key.d.ts

@@ -2,12 +2,13 @@ import { Document, Types } from "mongoose";
 import { PlatformApiKeyStatus } from "../enum";
 import { ITeam } from "./team";
 import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IPlatformApiKey extends Document {
     name: string;
     key_id: string;
     key_prefix: string;
-    owner_id: Types.ObjectId | IUser;
-    team_id?: Types.ObjectId | ITeam | null;
+    owner_id: Ref<IUser>;
+    team_id?: Ref<ITeam> | null;
     subscription_id?: Types.ObjectId | null;
     permissions: string[];
     status: PlatformApiKeyStatus;

package/dist/types/project/connection.d.ts

@@ -1,6 +1,7 @@
 import { Document } from "mongoose";
 import { IProject } from ".";
+import { Ref } from "../ref";
 export interface IProjectConnection extends Document {
-    service: IProject;
-    project: IProject;
+    service: Ref<IProject>;
+    project: Ref<IProject>;
 }

package/dist/types/project/index.d.ts

@@ -12,6 +12,7 @@ import { IAutoScalingGroup } from "../auto-scaling-group";
 import { IProjectEnvironment } from "../project-environment";
 import { IRegion } from "../region";
 import { IVolume } from "../volume";
+import { Ref } from "../ref";
 export type RuntimeVersions = Record<string, string>;
 export interface IPgBouncerConfig {
     defaultPoolSize: number;
@@ -36,8 +37,8 @@ export interface IProject extends Document {
     buildCacheEnabled?: boolean;
     alerting_enabled: boolean;
     logDrainsEnabled: boolean;
-    domains: Array<IDomain>;
-    environments: Array<IEnv>;
+    domains: Array<Ref<IDomain>>;
+    environments: Array<Ref<IEnv>>;
     uuid: number;
     pid: number;
     port: number;
@@ -53,7 +54,7 @@ export interface IProject extends Document {
     tlsHost?: string | null;
     tlsPort?: number | null;
     tlsSslModeHint?: string | null;
-    dbImage: IDbImage;
+    dbImage: Ref<IDbImage>;
     public: boolean;
     installCommand: string;
     buildCommand: string;
@@ -61,7 +62,7 @@ export interface IProject extends Document {
     outputDirectory: string;
     runtimeVersions?: RuntimeVersions | null;
     workBenchEnabled: boolean;
-    user_id: IUser;
+    user_id: Ref<IUser>;
     monitor_id: string;
     nomadJobId: string;
     watchPaths: string[];
@@ -75,14 +76,14 @@ export interface IProject extends Document {
     } | null;
     rootDir?: string;
     dockerfile?: string;
-    team: ITeam;
-    server: IServer;
+    team: Ref<ITeam>;
+    server: Ref<IServer>;
     isPrivate: boolean;
     status: PROJECT_STATUS;
     framework: string;
     description: string;
-    logs: Array<ILog>;
-    log: ILog;
+    logs: Array<Ref<ILog>>;
+    log: Ref<ILog>;
     maintenance: boolean;
     starred: boolean;
     passwordEnabled: boolean;
@@ -104,8 +105,8 @@ export interface IProject extends Document {
     lastProcessed: number;
     tracking_token: string;
     from: string;
-    previews: IPreview[];
-    project_environment?: IProjectEnvironment;
+    previews: Ref<IPreview>[];
+    project_environment?: Ref<IProjectEnvironment>;
     inherit_environment_vars: boolean;
     replicas: number;
     vaultPath: string | null;
@@ -114,7 +115,7 @@ export interface IProject extends Document {
         memory: number;
         cpu: number;
         storage: number;
-        region: IRegion;
+        region: Ref<IRegion>;
     };
     last_requested: Date;
     isPaused: boolean;
@@ -128,12 +129,12 @@ export interface IProject extends Document {
     last_backup_url?: string;
     last_backup_at?: Date;
     replica_ready: boolean;
-    autoscaling_group?: IAutoScalingGroup;
+    autoscaling_group?: Ref<IAutoScalingGroup>;
     isPaid: boolean;
     hasUpdates?: boolean;
     whiteListedIps?: string[];
     diskSize?: number;
     persistent_mount_path?: string;
     volumeMount: string;
-    volume: IVolume | null;
+    volume: Ref<IVolume> | null;
 }

package/dist/types/project/preview.d.ts

@@ -3,6 +3,7 @@ import { IServer } from "../server";
 import { IProject } from ".";
 import { PROJECT_STATUS } from "../../enum";
 import { ILog } from "../logs";
+import { Ref } from "../ref";
 export interface IPreview extends Document {
     name: string;
     healthCheckPath?: string;
@@ -12,11 +13,11 @@ export interface IPreview extends Document {
     http2: boolean;
     dir: string;
     branch: string;
-    server: IServer;
-    project: IProject;
+    server: Ref<IServer>;
+    project: Ref<IProject>;
     issue_comment_id: number;
     status: PROJECT_STATUS;
-    log: ILog;
+    log: Ref<ILog>;
     last_requested: Date;
     isPaused: boolean;
 }

package/dist/types/project-config-file.d.ts

@@ -1,13 +1,14 @@
 import { Document } from "mongoose";
 import { CONFIG_FILE_VISIBILITY } from "../enum";
 import { IProject, IUser } from "./";
+import { Ref } from "./ref";
 export interface IProjectConfigFile extends Document {
-    project: IProject | string;
+    project: Ref<IProject>;
     name: string;
     mount_path: string;
     visibility: CONFIG_FILE_VISIBILITY | "public" | "secret";
     size: number;
-    user: IUser | string;
+    user: Ref<IUser>;
     createdAt: Date;
     updatedAt: Date;
 }

package/dist/types/project-environment.d.ts

@@ -1,12 +1,13 @@
 import { Document } from "mongoose";
 import { ITeam } from "./team";
 import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IProjectEnvironment extends Document {
     name: string;
     slug: string;
-    owner: IUser;
-    team?: ITeam;
-    inherit_from?: IProjectEnvironment;
+    owner: Ref<IUser>;
+    team?: Ref<ITeam>;
+    inherit_from?: Ref<IProjectEnvironment>;
     isDefault: boolean;
     createdAt: Date;
     updatedAt: Date;

package/dist/types/project-network-settings.d.ts

@@ -1,8 +1,9 @@
 import { Document } from "mongoose";
 import { XContentTypeOptions, XFrameOptions, XRobotsTag } from "../enum";
 import { IProject } from "./project";
+import { Ref } from "./ref";
 export interface IProjectNetworkSettings extends Document {
-    project: IProject;
+    project: Ref<IProject>;
     cache: {
         purgeOnDeploy: boolean;
         bypassCache: boolean;

package/dist/types/project-tag-assignment.d.ts

@@ -3,11 +3,12 @@ import { ITag } from "./tag";
 import { IProject } from "./project";
 import { ITeam } from "./team";
 import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IProjectTagAssignment extends Document {
-    tagId: ITag;
-    projectId: IProject;
-    teamId: ITeam;
-    assignedBy: IUser;
+    tagId: Ref<ITag>;
+    projectId: Ref<IProject>;
+    teamId: Ref<ITeam>;
+    assignedBy: Ref<IUser>;
     createdAt: Date;
     updatedAt: Date;
 }

package/dist/types/ref.d.ts

@@ -0,0 +1,16 @@
+import { Types } from "mongoose";
+/**
+ * A Mongoose reference field. Holds an `ObjectId` unless the query populated it,
+ * so consumers must narrow before reading the referenced document.
+ */
+export type Ref<T> = T | Types.ObjectId;
+type PopulatedField<V> = V extends (infer E)[] ? Exclude<E, Types.ObjectId>[] : Exclude<V, Types.ObjectId>;
+/**
+ * Narrows the named reference fields of `T` to their populated documents. Use it
+ * on query return types so the populate contract lives with the query that
+ * performs it rather than at every call site.
+ */
+export type Populated<T, K extends keyof T> = Omit<T, K> & {
+    [P in K]: PopulatedField<T[P]>;
+};
+export {};

package/dist/types/ref.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/role.d.ts

@@ -1,9 +1,10 @@
 import { Document } from "mongoose";
 import { ROLES } from "../enum";
 import { IPermission } from "./permission";
+import { Ref } from "./ref";
 export interface IRole extends Document {
     type: ROLES;
     description?: string;
     is_custom?: boolean;
-    permissions: IPermission[];
+    permissions: Ref<IPermission>[];
 }

package/dist/types/sandbox-usage-segment.d.ts

@@ -1,7 +1,8 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
 import { ISandbox } from "./sandbox";
 import { IUser } from "./user";
 import { ITeam } from "./team";
+import { Ref } from "./ref";
 export interface ISandboxUsageSegmentCurrent {
     cpu: number;
     memory: number;
@@ -12,9 +13,9 @@ export interface ISandboxUsageSegmentCosts {
     endDate: Date | null;
 }
 export interface ISandboxUsageSegment extends Document {
-    sandbox_id: ISandbox | Types.ObjectId;
-    user_id: IUser | Types.ObjectId;
-    team_id: ITeam | Types.ObjectId | null;
+    sandbox_id: Ref<ISandbox>;
+    user_id: Ref<IUser>;
+    team_id: Ref<ITeam> | null;
     current: ISandboxUsageSegmentCurrent;
     costs: ISandboxUsageSegmentCosts;
     billed: boolean;

package/dist/types/sandbox.d.ts

@@ -4,6 +4,7 @@ import { ITeam } from "./team";
 import { IProjectEnvironment } from "./project-environment";
 import { SANDBOX_STATUS, SANDBOX_DESTROY_REASON, SANDBOX_EGRESS_MODE } from "../enum";
 import { IRegion } from "./region";
+import { Ref } from "./ref";
 export interface ISandboxSpecs {
     cpu: number;
     memory: number;
@@ -15,14 +16,14 @@ export interface ISandboxEgress {
 }
 export interface ISandbox extends Document {
     name: string;
-    user_id: IUser | Types.ObjectId;
-    team: ITeam | Types.ObjectId | null;
-    project_environment: IProjectEnvironment | Types.ObjectId | null;
+    user_id: Ref<IUser>;
+    team: Ref<ITeam> | null;
+    project_environment: Ref<IProjectEnvironment> | null;
     template: string;
     status: SANDBOX_STATUS;
     nomad_job_id: string;
     nomad_alloc_id: string | null;
-    region: IRegion;
+    region: Ref<IRegion>;
     specs: ISandboxSpecs;
     size: string | null;
     created_at: Date;

package/dist/types/server.d.ts

@@ -1,6 +1,7 @@
 import mongoose, { Document } from "mongoose";
 import { SERVER_STATUS, SERVER_PROTOCOL } from "../enum";
 import { IRegion } from "./region";
+import { Ref } from "./ref";
 export interface IServer extends Document {
     name: string;
     url: string;
@@ -19,7 +20,7 @@ export interface IServer extends Document {
     status: SERVER_STATUS;
     default: boolean;
     tag: string;
-    region: IRegion;
+    region: Ref<IRegion>;
     webhook_url?: string;
     is_custom_provision: boolean;
     firewall_id?: string;

package/dist/types/storage.d.ts

@@ -1,5 +1,6 @@
 import { Document, Types } from "mongoose";
 import { IProjectEnvironment } from "./project-environment";
+import { Ref } from "./ref";
 import { StorageBucketStatus, StorageCredentialRole, StorageCredentialStatus, StorageMigrationStatus, StorageTokenStatus, StorageUploadStatus } from "../enum";
 export type StorageTokenPermission = "read" | "write" | "delete" | "list" | "admin";
 export type StorageCorsRule = {
@@ -23,7 +24,7 @@ export type StorageLifecycleRuleTransition = {
 export interface IStorageBucket extends Document {
     name: string;
     project?: Types.ObjectId;
-    project_environment?: IProjectEnvironment | Types.ObjectId;
+    project_environment?: Ref<IProjectEnvironment>;
     user_id?: Types.ObjectId;
     team?: Types.ObjectId;
     bucket_name: string;
@@ -46,7 +47,7 @@ export interface IStorageBucket extends Document {
 export interface IStorageObject extends Document {
     bucket: Types.ObjectId;
     project?: Types.ObjectId;
-    project_environment?: IProjectEnvironment | Types.ObjectId;
+    project_environment?: Ref<IProjectEnvironment>;
     key: string;
     path: string;
     content_type?: string;
@@ -60,7 +61,7 @@ export interface IStorageObject extends Document {
 export interface IStorageUpload extends Document {
     bucket: Types.ObjectId;
     project?: Types.ObjectId;
-    project_environment?: IProjectEnvironment | Types.ObjectId;
+    project_environment?: Ref<IProjectEnvironment>;
     key: string;
     path: string;
     upload_id?: string;
@@ -91,7 +92,7 @@ export interface IStorageCredential extends Document {
     name: string;
     bucket: Types.ObjectId;
     project?: Types.ObjectId;
-    project_environment?: IProjectEnvironment | Types.ObjectId;
+    project_environment?: Ref<IProjectEnvironment>;
     user_id?: Types.ObjectId;
     team?: Types.ObjectId;
     provider: string;
@@ -108,7 +109,7 @@ export interface IStorageCredential extends Document {
 export interface IStorageMigration extends Document {
     bucket: Types.ObjectId;
     project?: Types.ObjectId;
-    project_environment?: IProjectEnvironment | Types.ObjectId;
+    project_environment?: Ref<IProjectEnvironment>;
     user_id?: Types.ObjectId;
     team?: Types.ObjectId;
     source_bucket: string;

package/dist/types/subscription.d.ts

@@ -3,14 +3,15 @@ import { SUBSCRIPTION_PLAN_TYPE, SUBSCRIPTION_STATUS } from "../enum";
 import { IUser } from "./user";
 import { ITeam } from "./team";
 import { IProject } from "./project";
+import { Ref } from "./ref";
 export interface ISubscription extends Document {
     initial_start_date: string;
-    team_id: ITeam;
+    team_id: Ref<ITeam>;
     due_amount: number;
-    admin_id: IUser;
+    admin_id: Ref<IUser>;
     downgraded: boolean;
-    billable_id: IUser;
-    project_id?: IProject;
+    billable_id: Ref<IUser>;
+    project_id?: Ref<IProject>;
     plan_type: SUBSCRIPTION_PLAN_TYPE;
     status: SUBSCRIPTION_STATUS;
     amount: number;

package/dist/types/tag.d.ts

@@ -1,11 +1,12 @@
 import { Document } from "mongoose";
 import { ITeam } from "./team";
 import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface ITag extends Document {
     name: string;
     color: string;
-    teamId: ITeam;
-    createdBy: IUser;
+    teamId: Ref<ITeam>;
+    createdBy: Ref<IUser>;
     createdAt: Date;
     updatedAt: Date;
 }

package/dist/types/team.d.ts

@@ -1,13 +1,14 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
 import { IMember, IProject, ISubscription, IUser } from "./";
 import { BUILD_DISABLED_BY, SPENDING_LIMIT_ACTION } from "../enum";
+import { Ref } from "./ref";
 export interface ITeam extends Document {
     name: string;
     slug: string;
     description: string;
     size: number;
-    members: IMember[];
-    projects: IProject[];
+    members: Ref<IMember>[];
+    projects: Ref<IProject>[];
     ai_usage_count: number;
     image: string;
     isCreator: boolean;
@@ -21,8 +22,10 @@ export interface ITeam extends Document {
     build_disabled_by: BUILD_DISABLED_BY;
     sandbox_disabled: boolean;
     sandbox_disabled_by: "system" | "payment_failure" | null;
-    subscription: ISubscription;
+    subscription: Ref<ISubscription>;
     enforce_2fa: boolean;
     enforce_2fa_at: Date | null;
-    enforce_2fa_by: IUser | Types.ObjectId | null;
+    enforce_2fa_by: Ref<IUser> | null;
+    createdAt: Date;
+    updatedAt: Date;
 }

package/dist/types/ticket.d.ts

@@ -1,8 +1,9 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
 import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface ITicket extends Document {
     airtable_id: string;
-    user_id: IUser | Types.ObjectId;
+    user_id: Ref<IUser>;
     email: string;
     subject: string;
     message: string;

package/dist/types/token.d.ts

@@ -1,9 +1,10 @@
 import { Document } from "mongoose";
 import { ISubscription } from "./subscription";
 import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IToken extends Document {
-    subscription_id: ISubscription;
-    owner_id: IUser;
+    subscription_id: Ref<ISubscription>;
+    owner_id: Ref<IUser>;
     key_id: string;
     key: string;
     tokens_remaining: number;

package/dist/types/user.d.ts

@@ -2,6 +2,7 @@ import { Document } from "mongoose";
 import { IFollowing, IProject, ITeam } from "./";
 import { IGit, IOrigin } from "./git";
 import { BUILD_DISABLED_BY, SPENDING_LIMIT_ACTION } from "../enum";
+import { Ref } from "./ref";
 export interface IUser extends Document {
     first_name: string;
     last_name: string;
@@ -19,9 +20,9 @@ export interface IUser extends Document {
     interests: Array<string>;
     bitbucket: IGit;
     origin?: IOrigin;
-    following: IFollowing[];
-    projects: IProject[];
-    teams: ITeam[];
+    following: Ref<IFollowing>[];
+    projects: Ref<IProject>[];
+    teams: Ref<ITeam>[];
     avatar: string;
     freeTrialActive: boolean;
     activated: boolean;

package/dist/types/volume.d.ts

@@ -2,16 +2,17 @@ import { Document, Types } from "mongoose";
 import { IUser } from "./user";
 import { ITeam } from "./team";
 import { IRegion } from "./region";
+import { Ref } from "./ref";
 export interface IVolume extends Document {
     name: string;
-    user?: IUser;
-    team?: ITeam;
+    user?: Ref<IUser>;
+    team?: Ref<ITeam>;
     namespace: string;
     size: number;
     type: string;
     mount_path?: string;
     csi_volume_id: string | null;
-    region: IRegion | null;
+    region: Ref<IRegion> | null;
     attached_sandbox_id: Types.ObjectId | null;
     attached_project_id: Types.ObjectId | null;
     last_attached_at: Date | null;

package/dist/types/webhook-event.d.ts

@@ -1,7 +1,8 @@
 import { Document } from "mongoose";
 import { IWebhookCategory } from "./webhook-category";
+import { Ref } from "./ref";
 export interface IWebhookEvent extends Document {
     name: string;
-    category: IWebhookCategory;
+    category: Ref<IWebhookCategory>;
     description: string;
 }

package/dist/types/webhook-setting.d.ts

@@ -3,10 +3,11 @@ import { IWebhookEvent } from "./webhook-event";
 import { ISubscription } from "./subscription";
 import { IUser } from "./user";
 import { ITeam } from "./team";
+import { Ref } from "./ref";
 export interface IWebhookSetting extends Document {
-    user_id: IUser;
-    team_id?: ITeam;
-    subscription_id: ISubscription;
+    user_id: Ref<IUser>;
+    team_id?: Ref<ITeam>;
+    subscription_id: Ref<ISubscription>;
     webhook_id: string;
     external_webhook_url?: string;
     webhookUrl: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brimble/models",
-  "version": "3.8.156",
+  "version": "4.0.0",
   "description": "Brimble models",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",