@brimble/models 4.0.1 → 4.0.3

package/dist/types/integration.d.ts

@@ -2,13 +2,13 @@ import { Document } from "mongoose";
 import { INTEGRATION_PROVIDERS, INTEGRATION_TYPES } from "../enum";
 export interface IIntegration extends Document {
     user_id: string;
-    team_id?: string;
-    app_id?: string;
+    team_id: string;
+    app_id: string;
     name: INTEGRATION_PROVIDERS;
-    scope_description?: string[];
-    hook?: string;
-    reference?: string;
-    token?: string;
+    scope_description: string[];
+    hook: string;
+    reference: string;
+    token: string;
     type: INTEGRATION_TYPES;
-    extra?: any;
+    extra: any;
 }

package/dist/types/intention.d.ts

@@ -8,7 +8,7 @@ export interface IIntention extends Document {
     sourceNamespace: string;
     destinationNamespace: string;
     action: "allow" | "deny";
-    description?: string;
+    description: string;
     createdAt: Date;
     updatedAt: Date;
 }

package/dist/types/job.d.ts

@@ -6,14 +6,14 @@ export interface IJob extends Document {
     url: string;
     method: string;
     schedule: string;
-    headers?: Map<string, string>;
-    maxAttempts?: number;
-    attempts?: number;
+    headers: Map<string, string>;
+    maxAttempts: number;
+    attempts: number;
     isRecurring: boolean;
-    lastRun?: Date;
-    nextRun?: Date;
-    body?: any;
-    status?: JobStatus;
-    createdAt?: Date;
-    updatedAt?: Date;
+    lastRun: Date;
+    nextRun: Date;
+    body: any;
+    status: JobStatus;
+    createdAt: Date;
+    updatedAt: Date;
 }

package/dist/types/license.d.ts

@@ -1,13 +1,17 @@
-import mongoose, { Document } from "mongoose";
+import { Document } from "mongoose";
 import { LicenseStatus } from "../enum";
+import { ISubscription } from "./subscription";
+import { ITeam } from "./team";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface ILicense extends Document {
     licenseKey: string;
     infisicalIdentity: string;
-    userId: mongoose.Types.ObjectId;
-    teamId: mongoose.Types.ObjectId;
+    userId: Ref<IUser>;
+    teamId: Ref<ITeam>;
     status: LicenseStatus;
     tag: string;
-    subscriptionId: mongoose.Types.ObjectId;
+    subscriptionId: Ref<ISubscription>;
     devices: Array<{
         deviceId: string;
         hostname: string;

package/dist/types/logs.d.ts

@@ -16,14 +16,14 @@ export interface ILog extends Document {
             name: string;
             email: string;
             username: string;
-            avatar_url?: string;
+            avatar_url: string;
         };
     };
     source: string;
     status: PROJECT_STATUS;
     project: Ref<IProject>;
-    user?: Ref<IUser>;
-    team?: Ref<ITeam>;
+    user: Ref<IUser>;
+    team: Ref<ITeam>;
     jobs: {
         id: number;
         name: string;

package/dist/types/member.d.ts

@@ -6,11 +6,11 @@ import { IProjectEnvironment } from "./project-environment";
 import { Ref } from "./ref";
 export interface IMember extends Document {
     /** Absent until an invited member registers; `email` identifies them until then. */
-    user?: Ref<IUser>;
+    user: Ref<IUser>;
     team: Ref<ITeam>;
     role: ROLES;
     accepted: boolean;
-    invitedBy?: Ref<IUser>;
+    invitedBy: Ref<IUser>;
     email: string;
     featureOnboarded: boolean;
     permissions: Ref<IMemberPermission>[];

package/dist/types/object-storage-usage-segment.d.ts

@@ -1,12 +1,16 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { IStorageBucket } from "./storage";
+import { ITeam } from "./team";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IObjectStorageUsageSegmentCosts {
     startDate: Date;
     endDate: Date | null;
 }
 export interface IObjectStorageUsageSegment extends Document {
-    bucket_id: Types.ObjectId;
-    user_id: Types.ObjectId;
-    team_id: Types.ObjectId | null;
+    bucket_id: Ref<IStorageBucket>;
+    user_id: Ref<IUser>;
+    team_id: Ref<ITeam> | null;
     size_gb: number;
     costs: IObjectStorageUsageSegmentCosts;
     billed: boolean;

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

@@ -1,13 +1,16 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { IProject } from "./project";
+import { ITeam } from "./team";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IPgBouncerUsageSegmentCosts {
     startDate: Date;
     endDate: Date | null;
 }
 export interface IPgBouncerUsageSegment extends Document {
-    _id: Types.ObjectId;
-    project_id: Types.ObjectId;
-    user_id: Types.ObjectId;
-    team_id: Types.ObjectId | null;
+    project_id: Ref<IProject>;
+    user_id: Ref<IUser>;
+    team_id: Ref<ITeam> | null;
     costs: IPgBouncerUsageSegmentCosts;
     billed: boolean;
     createdAt: Date;

package/dist/types/plan_configuration.d.ts

@@ -39,7 +39,7 @@ export interface IPlanConfiguration extends Document {
     unlimited_projects: boolean;
     webhook_enabled: boolean;
     can_deploy_all_applications: boolean;
-    stripe_prices?: Record<string, string>;
+    stripe_prices: Record<string, string>;
     storage_bucket_enabled: boolean;
     storage_bucket_quota_gb: number;
     sandbox_max_count: number;

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

@@ -1,5 +1,6 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
 import { PlatformApiKeyStatus } from "../enum";
+import { ISubscription } from "./subscription";
 import { ITeam } from "./team";
 import { IUser } from "./user";
 import { Ref } from "./ref";
@@ -8,12 +9,12 @@ export interface IPlatformApiKey extends Document {
     key_id: string;
     key_prefix: string;
     owner_id: Ref<IUser>;
-    team_id?: Ref<ITeam> | null;
-    subscription_id?: Types.ObjectId | null;
+    team_id: Ref<ITeam> | null;
+    subscription_id: Ref<ISubscription> | null;
     permissions: string[];
     status: PlatformApiKeyStatus;
-    expires_at?: Date | null;
-    last_used_at?: Date | null;
+    expires_at: Date | null;
+    last_used_at: Date | null;
     createdAt: Date;
     updatedAt: Date;
 }

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

@@ -26,15 +26,15 @@ export interface IPgBouncerConfig {
 }
 export interface IProject extends Document {
     name: string;
-    healthCheckPath?: string;
-    preStartCommand?: string;
+    healthCheckPath: string;
+    preStartCommand: string;
     backupEnabled: boolean;
     backup_mode: "automatic" | "manual";
     backup_schedule: string;
     http2: boolean;
-    free_tier_expires_at?: Date | null;
-    free_tier_expiry_notified_at?: Date | null;
-    buildCacheEnabled?: boolean;
+    free_tier_expires_at: Date | null;
+    free_tier_expiry_notified_at: Date | null;
+    buildCacheEnabled: boolean;
     alerting_enabled: boolean;
     logDrainsEnabled: boolean;
     domains: Array<Ref<IDomain>>;
@@ -47,20 +47,20 @@ export interface IProject extends Document {
     tlsEnabled: boolean;
     sendReport: boolean;
     pgbouncerEnabled: boolean;
-    pgbouncerConfig?: IPgBouncerConfig | null;
-    tlsEnabledAt?: Date | null;
-    tlsCaObjectKey?: string | null;
-    tlsServerCertExpiresAt?: Date | null;
-    tlsHost?: string | null;
-    tlsPort?: number | null;
-    tlsSslModeHint?: string | null;
+    pgbouncerConfig: IPgBouncerConfig | null;
+    tlsEnabledAt: Date | null;
+    tlsCaObjectKey: string | null;
+    tlsServerCertExpiresAt: Date | null;
+    tlsHost: string | null;
+    tlsPort: number | null;
+    tlsSslModeHint: string | null;
     dbImage: Ref<IDbImage>;
     public: boolean;
     installCommand: string;
     buildCommand: string;
     startCommand: string;
     outputDirectory: string;
-    runtimeVersions?: RuntimeVersions | null;
+    runtimeVersions: RuntimeVersions | null;
     workBenchEnabled: boolean;
     user_id: Ref<IUser>;
     monitor_id: string;
@@ -74,8 +74,8 @@ export interface IProject extends Document {
         installationId: string | number;
         git: GIT_TYPE;
     } | null;
-    rootDir?: string;
-    dockerfile?: string;
+    rootDir: string;
+    dockerfile: string;
     team: Ref<ITeam>;
     server: Ref<IServer>;
     isPrivate: boolean;
@@ -88,10 +88,10 @@ export interface IProject extends Document {
     starred: boolean;
     passwordEnabled: boolean;
     disabled: boolean;
-    disabled_at?: Date | null;
-    disabled_by?: PROJECT_DISABLED_BY | null;
+    disabled_at: Date | null;
+    disabled_by: PROJECT_DISABLED_BY | null;
     isDeleted: boolean;
-    deletedAt?: Date | null;
+    deletedAt: Date | null;
     authEnabled: boolean;
     password: string | null;
     deployedInCluster: boolean;
@@ -106,7 +106,7 @@ export interface IProject extends Document {
     tracking_token: string;
     from: string;
     previews: Ref<IPreview>[];
-    project_environment?: Ref<IProjectEnvironment>;
+    project_environment: Ref<IProjectEnvironment>;
     inherit_environment_vars: boolean;
     replicas: number;
     vaultPath: string | null;
@@ -121,20 +121,20 @@ export interface IProject extends Document {
     isPaused: boolean;
     paused_by: string | null;
     billable: boolean;
-    serviceType?: ServiceType;
-    cronEnabled?: boolean;
-    cronExpression?: string | null;
-    cronTimezone?: string | null;
-    cronCommand?: string | null;
-    last_backup_url?: string;
-    last_backup_at?: Date;
+    serviceType: ServiceType;
+    cronEnabled: boolean;
+    cronExpression: string | null;
+    cronTimezone: string | null;
+    cronCommand: string | null;
+    last_backup_url: string;
+    last_backup_at: Date;
     replica_ready: boolean;
-    autoscaling_group?: Ref<IAutoScalingGroup>;
+    autoscaling_group: Ref<IAutoScalingGroup>;
     isPaid: boolean;
-    hasUpdates?: boolean;
-    whiteListedIps?: string[];
-    diskSize?: number;
-    persistent_mount_path?: string;
+    hasUpdates: boolean;
+    whiteListedIps: string[];
+    diskSize: number;
+    persistent_mount_path: string;
     volumeMount: string;
     volume: Ref<IVolume> | null;
 }

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

@@ -6,7 +6,7 @@ import { ILog } from "../logs";
 import { Ref } from "../ref";
 export interface IPreview extends Document {
     name: string;
-    healthCheckPath?: string;
+    healthCheckPath: string;
     pid: number;
     port: number;
     ip: string;

package/dist/types/project-drain-subscription.d.ts

@@ -1,10 +1,12 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { IDrain } from "./drain";
+import { IProject } from "./project";
+import { Ref } from "./ref";
 export interface IProjectDrainSubscription extends Document {
-    _id: Types.ObjectId;
-    drain: Types.ObjectId;
-    project: Types.ObjectId;
+    drain: Ref<IDrain>;
+    project: Ref<IProject>;
     enabled: boolean;
-    disabledAt?: Date | null;
+    disabledAt: Date | null;
     createdAt: Date;
     updatedAt: Date;
 }

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

@@ -6,8 +6,8 @@ export interface IProjectEnvironment extends Document {
     name: string;
     slug: string;
     owner: Ref<IUser>;
-    team?: Ref<ITeam>;
-    inherit_from?: Ref<IProjectEnvironment>;
+    team: Ref<ITeam>;
+    inherit_from: Ref<IProjectEnvironment>;
     isDefault: boolean;
     createdAt: Date;
     updatedAt: Date;

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

@@ -22,8 +22,8 @@ export interface IProjectNetworkSettings extends Document {
         wordpressProtection: boolean;
     };
     cloudflare: {
-        lastSyncedAt?: Date;
-        syncError?: string;
+        lastSyncedAt: Date;
+        syncError: string;
     };
     createdAt: Date;
     updatedAt: Date;

package/dist/types/project_analytics.d.ts

@@ -1,9 +1,11 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { IProject } from "./project";
+import { Ref } from "./ref";
 export interface IProjectAnalytics extends Document {
-    project: Types.ObjectId;
+    project: Ref<IProject>;
     provider: "umami";
     websiteId: string;
-    shareId?: string | null;
+    shareId: string | null;
     domain: string;
     enabled: boolean;
     createdAt: Date;

package/dist/types/quest-campaign.d.ts

@@ -33,6 +33,6 @@ export interface IQuestCampaign extends Document {
     rewards: IQuestReward[];
     active: boolean;
     auto_expire: boolean;
-    created_at?: Date;
-    updated_at?: Date;
+    created_at: Date;
+    updated_at: Date;
 }

package/dist/types/quest-participation.d.ts

@@ -1,4 +1,7 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { IQuestCampaign } from "./quest-campaign";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IQuestCriterionProgress {
     key: string;
     current: number;
@@ -6,14 +9,14 @@ export interface IQuestCriterionProgress {
     met: boolean;
 }
 export interface IQuestParticipation extends Document {
-    campaign_id: Types.ObjectId;
-    user_id: Types.ObjectId;
+    campaign_id: Ref<IQuestCampaign>;
+    user_id: Ref<IUser>;
     joined_at: Date;
     slot_number: number;
     streak_deducted: number;
     criteria_progress: IQuestCriterionProgress[];
     qualifier_met: boolean;
     claimed_at: Date | null;
-    created_at?: Date;
-    updated_at?: Date;
+    created_at: Date;
+    updated_at: Date;
 }

package/dist/types/quest-reward-issuance.d.ts

@@ -1,17 +1,21 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
 import { QuestRewardStatus, RewardType } from "../enum";
+import { IQuestCampaign } from "./quest-campaign";
+import { IQuestParticipation } from "./quest-participation";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IQuestIssuedReward {
     type: RewardType;
     metadata: Record<string, unknown>;
 }
 export interface IQuestRewardIssuance extends Document {
-    participation_id: Types.ObjectId;
-    campaign_id: Types.ObjectId;
-    user_id: Types.ObjectId;
+    participation_id: Ref<IQuestParticipation>;
+    campaign_id: Ref<IQuestCampaign>;
+    user_id: Ref<IUser>;
     rewards: IQuestIssuedReward[];
     status: QuestRewardStatus;
     claimed_at: Date;
     fulfilled_at: Date | null;
-    created_at?: Date;
-    updated_at?: Date;
+    created_at: Date;
+    updated_at: Date;
 }

package/dist/types/ratelimit.d.ts

@@ -1,41 +1,43 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { IProject } from "./project";
+import { Ref } from "./ref";
 export type RateLimitMatcher = {
-    methods?: string[];
-    paths?: string[];
+    methods: string[];
+    paths: string[];
 };
 export type RateLimitZone = {
     name: string;
     key: string;
     window: string;
     events: number;
-    matcher?: RateLimitMatcher;
-    ipv4Prefix?: number;
-    ipv6Prefix?: number;
+    matcher: RateLimitMatcher;
+    ipv4Prefix: number;
+    ipv6Prefix: number;
 };
 export type DistributedRateLimitConfig = {
     enabled: boolean;
-    readInterval?: string;
-    writeInterval?: string;
-    purgeAge?: string;
+    readInterval: string;
+    writeInterval: string;
+    purgeAge: string;
 };
 export type RatelimitConfig = {
     enabled: boolean;
     zones: RateLimitZone[];
-    distributed?: DistributedRateLimitConfig;
-    logKey?: boolean;
-    disableMetrics?: boolean;
-    jitter?: number;
-    sweepInterval?: string;
+    distributed: DistributedRateLimitConfig;
+    logKey: boolean;
+    disableMetrics: boolean;
+    jitter: number;
+    sweepInterval: string;
 };
 export interface IRatelimit extends Document {
-    project: Types.ObjectId;
+    project: Ref<IProject>;
     enabled: boolean;
     zones: RateLimitZone[];
-    distributed?: DistributedRateLimitConfig;
+    distributed: DistributedRateLimitConfig;
     logKey: boolean;
     disableMetrics: boolean;
-    jitter?: number;
-    sweepInterval?: string;
+    jitter: number;
+    sweepInterval: string;
     createdAt: Date;
     updatedAt: Date;
 }

package/dist/types/ref.d.ts

@@ -1,7 +1,8 @@
 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.
+ * A Mongoose reference field. Holds an `ObjectId` unless the query that loaded
+ * the document populated it. Type that query's result as `Populated<T, K>`
+ * (or a named alias of it) so callers already know which refs are documents.
  */
 export type Ref<T> = T | Types.ObjectId;
 type PopulatedField<V> = V extends (infer E)[] ? Exclude<E, Types.ObjectId>[] : Exclude<V, Types.ObjectId>;

package/dist/types/region.d.ts

@@ -2,31 +2,31 @@ import { Types, Document } from "mongoose";
 import { REGION_CONTINENT, VOLUME_BACKEND } from "../enum";
 export type RegionType = "web" | "database" | "sandbox";
 export interface IRegionCsiConfig {
-    plugin_id?: string;
-    topology_path?: string;
-    require_topology?: boolean;
-    availability_zone?: string;
-    parameters?: Record<string, string>;
-    parameters_env?: Record<string, string>;
-    fs_type?: string;
-    attachment_modes?: string[];
+    plugin_id: string;
+    topology_path: string;
+    require_topology: boolean;
+    availability_zone: string;
+    parameters: Record<string, string>;
+    parameters_env: Record<string, string>;
+    fs_type: string;
+    attachment_modes: string[];
 }
 export interface IRegion extends Document {
     _id: Types.ObjectId;
     name: string;
     country: string;
     cname: string;
-    continent?: REGION_CONTINENT;
-    enabled?: boolean;
+    continent: REGION_CONTINENT;
+    enabled: boolean;
     dbVolumePath: string;
     is_paid: boolean;
     logo: string;
     provider: string;
     provider_identifier: string;
     storage_pricing_factor: number;
-    floating_ip?: string;
-    type?: RegionType;
-    ceph_cluster_id?: string;
-    volume_backend?: VOLUME_BACKEND;
-    csi?: IRegionCsiConfig;
+    floating_ip: string;
+    type: RegionType;
+    ceph_cluster_id: string;
+    volume_backend: VOLUME_BACKEND;
+    csi: IRegionCsiConfig;
 }

package/dist/types/restore-history.d.ts

@@ -1,10 +1,15 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
 import { RESTORE_STATUS } from "../enum";
+import { IBackupHistory } from "./backup-history";
+import { IProject } from "./project";
+import { ITeam } from "./team";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface IRestoreHistory extends Document {
-    project_id: Types.ObjectId;
-    backup_history_id: Types.ObjectId;
-    user_id: Types.ObjectId;
-    team: Types.ObjectId | null;
+    project_id: Ref<IProject>;
+    backup_history_id: Ref<IBackupHistory>;
+    user_id: Ref<IUser>;
+    team: Ref<ITeam> | null;
     status: RESTORE_STATUS;
     object_key: string;
     engine: string | null;

package/dist/types/role.d.ts

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

package/dist/types/sandbox-activity.d.ts

@@ -1,14 +1,18 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { ISandbox } from "./sandbox";
+import { ITeam } from "./team";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface ISandboxActivity extends Document {
-    sandbox_id: Types.ObjectId;
-    user_id: Types.ObjectId;
-    team: Types.ObjectId | null;
+    sandbox_id: Ref<ISandbox>;
+    user_id: Ref<IUser>;
+    team: Ref<ITeam> | null;
     command: string;
     started_at: Date;
     ended_at: Date | null;
     exit_code: number | null;
     duration_ms: number | null;
     error: string | null;
-    created_at?: Date;
-    updated_at?: Date;
+    created_at: Date;
+    updated_at: Date;
 }

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

@@ -1,13 +1,16 @@
-import { Document, Types } from "mongoose";
+import { Document } from "mongoose";
+import { ISandboxSnapshot } from "./sandbox-snapshot";
+import { ITeam } from "./team";
+import { IUser } from "./user";
+import { Ref } from "./ref";
 export interface ISandboxSnapshotUsageSegmentCosts {
     startDate: Date;
     endDate: Date | null;
 }
 export interface ISandboxSnapshotUsageSegment extends Document {
-    _id: Types.ObjectId;
-    snapshot_id: Types.ObjectId;
-    user_id: Types.ObjectId;
-    team_id: Types.ObjectId | null;
+    snapshot_id: Ref<ISandboxSnapshot>;
+    user_id: Ref<IUser>;
+    team_id: Ref<ITeam> | null;
     size_gb: number;
     costs: ISandboxSnapshotUsageSegmentCosts;
     billed: boolean;