@brimble/models 4.0.1 → 4.0.2

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/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

@@ -8,12 +8,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: Types.ObjectId | 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

@@ -4,7 +4,7 @@ export interface IProjectDrainSubscription extends Document {
     drain: Types.ObjectId;
     project: Types.ObjectId;
     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

@@ -3,7 +3,7 @@ export interface IProjectAnalytics extends Document {
     project: Types.ObjectId;
     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

@@ -14,6 +14,6 @@ export interface IQuestParticipation extends Document {
     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

@@ -12,6 +12,6 @@ export interface IQuestRewardIssuance extends Document {
     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,41 @@
 import { Document, Types } from "mongoose";
 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;
     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/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

@@ -9,6 +9,6 @@ export interface ISandboxActivity extends Document {
     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-usage-segment.d.ts

@@ -19,8 +19,8 @@ export interface ISandboxUsageSegment extends Document {
     current: ISandboxUsageSegmentCurrent;
     costs: ISandboxUsageSegmentCosts;
     billed: boolean;
-    region?: string;
-    template?: string;
+    region: string;
+    template: string;
     createdAt: Date;
     updatedAt: Date;
 }

package/dist/types/sandbox.d.ts

@@ -35,7 +35,7 @@ export interface ISandbox extends Document {
     destroy_timeout: string | null;
     one_shot: boolean;
     block_outbound: boolean;
-    egress?: ISandboxEgress | null;
+    egress: ISandboxEgress | null;
     persistent: boolean;
     persistent_disk_gb: number | null;
     csi_volume_id: string | null;

package/dist/types/server.d.ts

@@ -5,13 +5,13 @@ import { Ref } from "./ref";
 export interface IServer extends Document {
     name: string;
     url: string;
-    grpc_address?: string;
-    ipv6?: string;
-    domain?: string;
+    grpc_address: string;
+    ipv6: string;
+    domain: string;
     node_id: string;
     force_deactivation: boolean;
     userId: mongoose.Types.ObjectId;
-    teamId?: mongoose.Types.ObjectId;
+    teamId: mongoose.Types.ObjectId;
     ip_address: string;
     private_ip_address: string;
     tunnel_token: string;
@@ -21,15 +21,15 @@ export interface IServer extends Document {
     default: boolean;
     tag: string;
     region: Ref<IRegion>;
-    webhook_url?: string;
+    webhook_url: string;
     is_custom_provision: boolean;
-    firewall_id?: string;
+    firewall_id: string;
     specifications: Record<any, any>;
-    plugin_id?: string;
+    plugin_id: string;
     provider: string;
-    provider_location?: string;
-    provider_identifier?: string;
-    topology_path?: string;
-    cert_storage_path?: string | null;
+    provider_location: string;
+    provider_identifier: string;
+    topology_path: string;
+    cert_storage_path: string | null;
     meta: Record<any, any>;
 }

package/dist/types/storage.d.ts

@@ -4,29 +4,29 @@ import { Ref } from "./ref";
 import { StorageBucketStatus, StorageCredentialRole, StorageCredentialStatus, StorageMigrationStatus, StorageTokenStatus, StorageUploadStatus } from "../enum";
 export type StorageTokenPermission = "read" | "write" | "delete" | "list" | "admin";
 export type StorageCorsRule = {
-    allowedHeaders?: string[];
-    allowedMethods?: string[];
-    allowedOrigins?: string[];
-    exposeHeaders?: string[];
-    maxAgeSeconds?: number;
+    allowedHeaders: string[];
+    allowedMethods: string[];
+    allowedOrigins: string[];
+    exposeHeaders: string[];
+    maxAgeSeconds: number;
     [key: string]: unknown;
 };
 export type StorageLifecycleRule = {
-    id?: string;
-    prefix?: string;
-    expirationDays?: number;
-    transitions?: StorageLifecycleRuleTransition[];
+    id: string;
+    prefix: string;
+    expirationDays: number;
+    transitions: StorageLifecycleRuleTransition[];
 };
 export type StorageLifecycleRuleTransition = {
-    days?: number;
-    storageClass?: string;
+    days: number;
+    storageClass: string;
 };
 export interface IStorageBucket extends Document {
     name: string;
-    project?: Types.ObjectId;
-    project_environment?: Ref<IProjectEnvironment>;
-    user_id?: Types.ObjectId;
-    team?: Types.ObjectId;
+    project: Types.ObjectId;
+    project_environment: Ref<IProjectEnvironment>;
+    user_id: Types.ObjectId;
+    team: Types.ObjectId;
     bucket_name: string;
     is_public: boolean;
     versioning: boolean;
@@ -46,30 +46,30 @@ export interface IStorageBucket extends Document {
 }
 export interface IStorageObject extends Document {
     bucket: Types.ObjectId;
-    project?: Types.ObjectId;
-    project_environment?: Ref<IProjectEnvironment>;
+    project: Types.ObjectId;
+    project_environment: Ref<IProjectEnvironment>;
     key: string;
     path: string;
-    content_type?: string;
+    content_type: string;
     size: number;
-    etag?: string;
-    public_url?: string;
-    last_modified?: Date;
+    etag: string;
+    public_url: string;
+    last_modified: Date;
     createdAt: Date;
     updatedAt: Date;
 }
 export interface IStorageUpload extends Document {
     bucket: Types.ObjectId;
-    project?: Types.ObjectId;
-    project_environment?: Ref<IProjectEnvironment>;
+    project: Types.ObjectId;
+    project_environment: Ref<IProjectEnvironment>;
     key: string;
     path: string;
-    upload_id?: string;
-    content_type?: string;
+    upload_id: string;
+    content_type: string;
     size: number;
     status: StorageUploadStatus;
     expires_at: Date;
-    completed_at?: Date;
+    completed_at: Date;
     createdAt: Date;
     updatedAt: Date;
 }
@@ -77,46 +77,46 @@ export interface IStorageToken extends Document {
     name: string;
     token_hash: string;
     prefix: string;
-    project?: Types.ObjectId;
+    project: Types.ObjectId;
     buckets: Types.ObjectId[];
-    user_id?: Types.ObjectId;
-    team?: Types.ObjectId;
+    user_id: Types.ObjectId;
+    team: Types.ObjectId;
     permissions: StorageTokenPermission[];
     status: StorageTokenStatus;
-    last_used_at?: Date;
-    expires_at?: Date;
+    last_used_at: Date;
+    expires_at: Date;
     createdAt: Date;
     updatedAt: Date;
 }
 export interface IStorageCredential extends Document {
     name: string;
     bucket: Types.ObjectId;
-    project?: Types.ObjectId;
-    project_environment?: Ref<IProjectEnvironment>;
-    user_id?: Types.ObjectId;
-    team?: Types.ObjectId;
+    project: Types.ObjectId;
+    project_environment: Ref<IProjectEnvironment>;
+    user_id: Types.ObjectId;
+    team: Types.ObjectId;
     provider: string;
     provider_org_id: string;
     access_key_id: string;
     policy_names: string[];
     role: StorageCredentialRole;
     status: StorageCredentialStatus;
-    last_rotated_at?: Date;
-    revoked_at?: Date;
+    last_rotated_at: Date;
+    revoked_at: Date;
     createdAt: Date;
     updatedAt: Date;
 }
 export interface IStorageMigration extends Document {
     bucket: Types.ObjectId;
-    project?: Types.ObjectId;
-    project_environment?: Ref<IProjectEnvironment>;
-    user_id?: Types.ObjectId;
-    team?: Types.ObjectId;
+    project: Types.ObjectId;
+    project_environment: Ref<IProjectEnvironment>;
+    user_id: Types.ObjectId;
+    team: Types.ObjectId;
     source_bucket: string;
     source_region: string;
-    source_endpoint?: string;
-    source_prefix?: string;
-    destination_prefix?: string;
+    source_endpoint: string;
+    source_prefix: string;
+    destination_prefix: string;
     vault_path: string;
     status: StorageMigrationStatus;
     total_objects: number;
@@ -124,12 +124,12 @@ export interface IStorageMigration extends Document {
     failed_objects: number;
     total_bytes: number;
     copied_bytes: number;
-    continuation_token?: string;
-    last_source_key?: string;
-    error_message?: string;
-    started_at?: Date;
-    completed_at?: Date;
-    cancelled_at?: Date;
+    continuation_token: string;
+    last_source_key: string;
+    error_message: string;
+    started_at: Date;
+    completed_at: Date;
+    cancelled_at: Date;
     createdAt: Date;
     updatedAt: Date;
 }

package/dist/types/streak-day.d.ts

@@ -4,6 +4,6 @@ export interface IStreakDay extends Document {
     day: Date;
     action_types: string[];
     is_milestone_day: boolean;
-    created_at?: Date;
-    updated_at?: Date;
+    created_at: Date;
+    updated_at: Date;
 }

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

@@ -8,6 +8,6 @@ export interface IStreakEvent extends Document {
     service_type: string | null;
     system_day: Date;
     dedupe_key: string;
-    created_at?: Date;
-    updated_at?: Date;
+    created_at: Date;
+    updated_at: Date;
 }