@contractspec/lib.metering 3.7.17 → 3.7.18

package/dist/node/contracts/index.js

@@ -1,617 +1 @@
-// src/contracts/index.ts
-import { defineCommand, defineQuery } from "@contractspec/lib.contracts-spec";
-import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
-var OWNERS = ["platform.metering"];
-var MetricDefinitionModel = defineSchemaModel({
-  name: "MetricDefinition",
-  description: "Represents a metric definition",
-  fields: {
-    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    key: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    unit: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    aggregationType: {
-      type: ScalarTypeEnum.String_unsecure(),
-      isOptional: false
-    },
-    resetPeriod: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    isActive: { type: ScalarTypeEnum.Boolean(), isOptional: false },
-    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
-  }
-});
-var UsageRecordModel = defineSchemaModel({
-  name: "UsageRecord",
-  description: "Represents a usage record",
-  fields: {
-    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    quantity: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
-    source: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    resourceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    resourceType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    metadata: { type: ScalarTypeEnum.JSON(), isOptional: true },
-    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
-  }
-});
-var UsageSummaryModel = defineSchemaModel({
-  name: "UsageSummary",
-  description: "Represents aggregated usage",
-  fields: {
-    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    periodType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    periodStart: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    periodEnd: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    totalQuantity: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
-    recordCount: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-    minQuantity: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
-    maxQuantity: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
-    avgQuantity: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true }
-  }
-});
-var UsageThresholdModel = defineSchemaModel({
-  name: "UsageThreshold",
-  description: "Represents a usage threshold",
-  fields: {
-    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    threshold: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
-    warnThreshold: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
-    periodType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    action: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    currentValue: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
-    isActive: { type: ScalarTypeEnum.Boolean(), isOptional: false },
-    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: false }
-  }
-});
-var DefineMetricInput = defineSchemaModel({
-  name: "DefineMetricInput",
-  description: "Input for defining a metric",
-  fields: {
-    key: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    unit: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    aggregationType: {
-      type: ScalarTypeEnum.String_unsecure(),
-      isOptional: true
-    },
-    resetPeriod: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    metadata: { type: ScalarTypeEnum.JSON(), isOptional: true }
-  }
-});
-var UpdateMetricInput = defineSchemaModel({
-  name: "UpdateMetricInput",
-  description: "Input for updating a metric",
-  fields: {
-    metricId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    description: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    isActive: { type: ScalarTypeEnum.Boolean(), isOptional: true },
-    metadata: { type: ScalarTypeEnum.JSON(), isOptional: true }
-  }
-});
-var DeleteMetricInput = defineSchemaModel({
-  name: "DeleteMetricInput",
-  description: "Input for deleting a metric",
-  fields: {
-    metricId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
-  }
-});
-var GetMetricInput = defineSchemaModel({
-  name: "GetMetricInput",
-  description: "Input for getting a metric",
-  fields: {
-    key: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
-  }
-});
-var ListMetricsInput = defineSchemaModel({
-  name: "ListMetricsInput",
-  description: "Input for listing metrics",
-  fields: {
-    orgId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    category: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    isActive: { type: ScalarTypeEnum.Boolean(), isOptional: true },
-    limit: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
-    offset: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true }
-  }
-});
-var ListMetricsOutput = defineSchemaModel({
-  name: "ListMetricsOutput",
-  description: "Output for listing metrics",
-  fields: {
-    metrics: { type: MetricDefinitionModel, isArray: true, isOptional: false },
-    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false }
-  }
-});
-var RecordUsageInput = defineSchemaModel({
-  name: "RecordUsageInput",
-  description: "Input for recording usage",
-  fields: {
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    quantity: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
-    timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: true },
-    source: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    resourceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    resourceType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    metadata: { type: ScalarTypeEnum.JSON(), isOptional: true },
-    idempotencyKey: {
-      type: ScalarTypeEnum.String_unsecure(),
-      isOptional: true
-    }
-  }
-});
-var RecordBatchUsageInput = defineSchemaModel({
-  name: "RecordBatchUsageInput",
-  description: "Input for recording batch usage",
-  fields: {
-    records: { type: RecordUsageInput, isArray: true, isOptional: false }
-  }
-});
-var RecordBatchUsageOutput = defineSchemaModel({
-  name: "RecordBatchUsageOutput",
-  description: "Output for recording batch usage",
-  fields: {
-    recordedCount: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-    skippedCount: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-    recordIds: { type: ScalarTypeEnum.JSON(), isOptional: false }
-  }
-});
-var GetUsageInput = defineSchemaModel({
-  name: "GetUsageInput",
-  description: "Input for getting usage",
-  fields: {
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    startDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    endDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    limit: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
-    offset: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true }
-  }
-});
-var GetUsageOutput = defineSchemaModel({
-  name: "GetUsageOutput",
-  description: "Output for getting usage",
-  fields: {
-    records: { type: UsageRecordModel, isArray: true, isOptional: false },
-    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-    totalQuantity: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false }
-  }
-});
-var GetUsageSummaryInput = defineSchemaModel({
-  name: "GetUsageSummaryInput",
-  description: "Input for getting usage summary",
-  fields: {
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    periodType: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    startDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    endDate: { type: ScalarTypeEnum.DateTime(), isOptional: true }
-  }
-});
-var GetUsageSummaryOutput = defineSchemaModel({
-  name: "GetUsageSummaryOutput",
-  description: "Output for getting usage summary",
-  fields: {
-    summaries: { type: UsageSummaryModel, isArray: true, isOptional: false },
-    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false }
-  }
-});
-var CreateThresholdInput = defineSchemaModel({
-  name: "CreateThresholdInput",
-  description: "Input for creating a threshold",
-  fields: {
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    threshold: { type: ScalarTypeEnum.Float_unsecure(), isOptional: false },
-    warnThreshold: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
-    periodType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    action: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    notifyEmails: { type: ScalarTypeEnum.JSON(), isOptional: true },
-    notifyWebhook: { type: ScalarTypeEnum.String_unsecure(), isOptional: true }
-  }
-});
-var UpdateThresholdInput = defineSchemaModel({
-  name: "UpdateThresholdInput",
-  description: "Input for updating a threshold",
-  fields: {
-    thresholdId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    name: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    threshold: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
-    warnThreshold: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
-    action: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    notifyEmails: { type: ScalarTypeEnum.JSON(), isOptional: true },
-    notifyWebhook: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    isActive: { type: ScalarTypeEnum.Boolean(), isOptional: true }
-  }
-});
-var DeleteThresholdInput = defineSchemaModel({
-  name: "DeleteThresholdInput",
-  description: "Input for deleting a threshold",
-  fields: {
-    thresholdId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false }
-  }
-});
-var ListThresholdsInput = defineSchemaModel({
-  name: "ListThresholdsInput",
-  description: "Input for listing thresholds",
-  fields: {
-    metricKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    subjectType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    subjectId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    isActive: { type: ScalarTypeEnum.Boolean(), isOptional: true }
-  }
-});
-var ListThresholdsOutput = defineSchemaModel({
-  name: "ListThresholdsOutput",
-  description: "Output for listing thresholds",
-  fields: {
-    thresholds: { type: UsageThresholdModel, isArray: true, isOptional: false },
-    total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false }
-  }
-});
-var SuccessOutput = defineSchemaModel({
-  name: "SuccessOutput",
-  description: "Generic success output",
-  fields: {
-    success: { type: ScalarTypeEnum.Boolean(), isOptional: false }
-  }
-});
-var DefineMetricContract = defineCommand({
-  meta: {
-    key: "metric.define",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "metric", "define"],
-    description: "Define a new usage metric.",
-    goal: "Create a new metric for tracking usage.",
-    context: "Called when setting up metering."
-  },
-  io: {
-    input: DefineMetricInput,
-    output: MetricDefinitionModel,
-    errors: {
-      METRIC_KEY_EXISTS: {
-        description: "Metric key already exists",
-        http: 409,
-        gqlCode: "METRIC_KEY_EXISTS",
-        when: "A metric with this key already exists"
-      }
-    }
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var UpdateMetricContract = defineCommand({
-  meta: {
-    key: "metric.update",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "metric", "update"],
-    description: "Update a metric definition.",
-    goal: "Modify metric configuration.",
-    context: "Called when updating metric settings."
-  },
-  io: {
-    input: UpdateMetricInput,
-    output: MetricDefinitionModel,
-    errors: {
-      METRIC_NOT_FOUND: {
-        description: "Metric does not exist",
-        http: 404,
-        gqlCode: "METRIC_NOT_FOUND",
-        when: "Metric ID is invalid"
-      }
-    }
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var DeleteMetricContract = defineCommand({
-  meta: {
-    key: "metric.delete",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "metric", "delete"],
-    description: "Delete a metric definition.",
-    goal: "Remove a metric and its data.",
-    context: "Called when removing a metric."
-  },
-  io: {
-    input: DeleteMetricInput,
-    output: SuccessOutput,
-    errors: {
-      METRIC_NOT_FOUND: {
-        description: "Metric does not exist",
-        http: 404,
-        gqlCode: "METRIC_NOT_FOUND",
-        when: "Metric ID is invalid"
-      }
-    }
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var GetMetricContract = defineQuery({
-  meta: {
-    key: "metric.get",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "metric", "get"],
-    description: "Get a metric by key.",
-    goal: "Retrieve metric definition.",
-    context: "Called to inspect metric details."
-  },
-  io: {
-    input: GetMetricInput,
-    output: MetricDefinitionModel,
-    errors: {
-      METRIC_NOT_FOUND: {
-        description: "Metric does not exist",
-        http: 404,
-        gqlCode: "METRIC_NOT_FOUND",
-        when: "Metric key is invalid"
-      }
-    }
-  },
-  policy: {
-    auth: "user"
-  }
-});
-var ListMetricsContract = defineQuery({
-  meta: {
-    key: "metric.list",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "metric", "list"],
-    description: "List all metrics.",
-    goal: "View configured metrics.",
-    context: "Called to browse metrics."
-  },
-  io: {
-    input: ListMetricsInput,
-    output: ListMetricsOutput
-  },
-  policy: {
-    auth: "user"
-  }
-});
-var RecordUsageContract = defineCommand({
-  meta: {
-    key: "usage.record",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "usage", "record"],
-    description: "Record a usage event.",
-    goal: "Track usage for billing and monitoring.",
-    context: "Called when usage occurs."
-  },
-  io: {
-    input: RecordUsageInput,
-    output: UsageRecordModel,
-    errors: {
-      METRIC_NOT_FOUND: {
-        description: "Metric does not exist",
-        http: 404,
-        gqlCode: "METRIC_NOT_FOUND",
-        when: "Metric key is invalid"
-      },
-      DUPLICATE_RECORD: {
-        description: "Record already exists",
-        http: 409,
-        gqlCode: "DUPLICATE_RECORD",
-        when: "Idempotency key already used"
-      }
-    }
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var RecordBatchUsageContract = defineCommand({
-  meta: {
-    key: "usage.recordBatch",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "usage", "batch"],
-    description: "Record multiple usage events.",
-    goal: "Efficiently track bulk usage.",
-    context: "Called for batch processing."
-  },
-  io: {
-    input: RecordBatchUsageInput,
-    output: RecordBatchUsageOutput
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var GetUsageContract = defineQuery({
-  meta: {
-    key: "usage.get",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "usage", "get"],
-    description: "Get usage records for a subject.",
-    goal: "View detailed usage history.",
-    context: "Called to analyze usage."
-  },
-  io: {
-    input: GetUsageInput,
-    output: GetUsageOutput
-  },
-  policy: {
-    auth: "user"
-  }
-});
-var GetUsageSummaryContract = defineQuery({
-  meta: {
-    key: "usage.getSummary",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "usage", "summary"],
-    description: "Get aggregated usage summary.",
-    goal: "View usage totals for billing.",
-    context: "Called for billing and reporting."
-  },
-  io: {
-    input: GetUsageSummaryInput,
-    output: GetUsageSummaryOutput
-  },
-  policy: {
-    auth: "user"
-  }
-});
-var CreateThresholdContract = defineCommand({
-  meta: {
-    key: "threshold.create",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "threshold", "create"],
-    description: "Create a usage threshold.",
-    goal: "Set up usage limits and alerts.",
-    context: "Called when configuring limits."
-  },
-  io: {
-    input: CreateThresholdInput,
-    output: UsageThresholdModel,
-    errors: {
-      METRIC_NOT_FOUND: {
-        description: "Metric does not exist",
-        http: 404,
-        gqlCode: "METRIC_NOT_FOUND",
-        when: "Metric key is invalid"
-      }
-    }
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var UpdateThresholdContract = defineCommand({
-  meta: {
-    key: "threshold.update",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "threshold", "update"],
-    description: "Update a threshold.",
-    goal: "Modify threshold configuration.",
-    context: "Called when adjusting limits."
-  },
-  io: {
-    input: UpdateThresholdInput,
-    output: UsageThresholdModel,
-    errors: {
-      THRESHOLD_NOT_FOUND: {
-        description: "Threshold does not exist",
-        http: 404,
-        gqlCode: "THRESHOLD_NOT_FOUND",
-        when: "Threshold ID is invalid"
-      }
-    }
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var DeleteThresholdContract = defineCommand({
-  meta: {
-    key: "threshold.delete",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "threshold", "delete"],
-    description: "Delete a threshold.",
-    goal: "Remove a usage threshold.",
-    context: "Called when removing limits."
-  },
-  io: {
-    input: DeleteThresholdInput,
-    output: SuccessOutput,
-    errors: {
-      THRESHOLD_NOT_FOUND: {
-        description: "Threshold does not exist",
-        http: 404,
-        gqlCode: "THRESHOLD_NOT_FOUND",
-        when: "Threshold ID is invalid"
-      }
-    }
-  },
-  policy: {
-    auth: "admin"
-  }
-});
-var ListThresholdsContract = defineQuery({
-  meta: {
-    key: "threshold.list",
-    version: "1.0.0",
-    stability: "stable",
-    owners: [...OWNERS],
-    tags: ["metering", "threshold", "list"],
-    description: "List usage thresholds.",
-    goal: "View configured limits.",
-    context: "Called to browse thresholds."
-  },
-  io: {
-    input: ListThresholdsInput,
-    output: ListThresholdsOutput
-  },
-  policy: {
-    auth: "user"
-  }
-});
-export {
-  UsageThresholdModel,
-  UsageSummaryModel,
-  UsageRecordModel,
-  UpdateThresholdContract,
-  UpdateMetricContract,
-  RecordUsageContract,
-  RecordBatchUsageContract,
-  MetricDefinitionModel,
-  ListThresholdsContract,
-  ListMetricsContract,
-  GetUsageSummaryContract,
-  GetUsageContract,
-  GetMetricContract,
-  DeleteThresholdContract,
-  DeleteMetricContract,
-  DefineMetricContract,
-  CreateThresholdContract
-};
+import{defineCommand as v,defineQuery as w}from"@contractspec/lib.contracts-spec";import{defineSchemaModel as k,ScalarTypeEnum as j}from"@contractspec/lib.schema";var q=["platform.metering"],x=k({name:"MetricDefinition",description:"Represents a metric definition",fields:{id:{type:j.String_unsecure(),isOptional:!1},key:{type:j.String_unsecure(),isOptional:!1},name:{type:j.String_unsecure(),isOptional:!1},description:{type:j.String_unsecure(),isOptional:!0},unit:{type:j.String_unsecure(),isOptional:!1},aggregationType:{type:j.String_unsecure(),isOptional:!1},resetPeriod:{type:j.String_unsecure(),isOptional:!1},category:{type:j.String_unsecure(),isOptional:!0},isActive:{type:j.Boolean(),isOptional:!1},orgId:{type:j.String_unsecure(),isOptional:!0},createdAt:{type:j.DateTime(),isOptional:!1},updatedAt:{type:j.DateTime(),isOptional:!1}}}),A=k({name:"UsageRecord",description:"Represents a usage record",fields:{id:{type:j.String_unsecure(),isOptional:!1},metricKey:{type:j.String_unsecure(),isOptional:!1},subjectType:{type:j.String_unsecure(),isOptional:!1},subjectId:{type:j.String_unsecure(),isOptional:!1},quantity:{type:j.Float_unsecure(),isOptional:!1},source:{type:j.String_unsecure(),isOptional:!0},resourceId:{type:j.String_unsecure(),isOptional:!0},resourceType:{type:j.String_unsecure(),isOptional:!0},metadata:{type:j.JSON(),isOptional:!0},timestamp:{type:j.DateTime(),isOptional:!1},createdAt:{type:j.DateTime(),isOptional:!1}}}),J=k({name:"UsageSummary",description:"Represents aggregated usage",fields:{id:{type:j.String_unsecure(),isOptional:!1},metricKey:{type:j.String_unsecure(),isOptional:!1},subjectType:{type:j.String_unsecure(),isOptional:!1},subjectId:{type:j.String_unsecure(),isOptional:!1},periodType:{type:j.String_unsecure(),isOptional:!1},periodStart:{type:j.DateTime(),isOptional:!1},periodEnd:{type:j.DateTime(),isOptional:!1},totalQuantity:{type:j.Float_unsecure(),isOptional:!1},recordCount:{type:j.Int_unsecure(),isOptional:!1},minQuantity:{type:j.Float_unsecure(),isOptional:!0},maxQuantity:{type:j.Float_unsecure(),isOptional:!0},avgQuantity:{type:j.Float_unsecure(),isOptional:!0}}}),z=k({name:"UsageThreshold",description:"Represents a usage threshold",fields:{id:{type:j.String_unsecure(),isOptional:!1},metricKey:{type:j.String_unsecure(),isOptional:!1},subjectType:{type:j.String_unsecure(),isOptional:!0},subjectId:{type:j.String_unsecure(),isOptional:!0},name:{type:j.String_unsecure(),isOptional:!1},threshold:{type:j.Float_unsecure(),isOptional:!1},warnThreshold:{type:j.Float_unsecure(),isOptional:!0},periodType:{type:j.String_unsecure(),isOptional:!1},action:{type:j.String_unsecure(),isOptional:!1},currentValue:{type:j.Float_unsecure(),isOptional:!1},isActive:{type:j.Boolean(),isOptional:!1},createdAt:{type:j.DateTime(),isOptional:!1}}}),K=k({name:"DefineMetricInput",description:"Input for defining a metric",fields:{key:{type:j.String_unsecure(),isOptional:!1},name:{type:j.String_unsecure(),isOptional:!1},description:{type:j.String_unsecure(),isOptional:!0},unit:{type:j.String_unsecure(),isOptional:!1},aggregationType:{type:j.String_unsecure(),isOptional:!0},resetPeriod:{type:j.String_unsecure(),isOptional:!0},category:{type:j.String_unsecure(),isOptional:!0},orgId:{type:j.String_unsecure(),isOptional:!0},metadata:{type:j.JSON(),isOptional:!0}}}),P=k({name:"UpdateMetricInput",description:"Input for updating a metric",fields:{metricId:{type:j.String_unsecure(),isOptional:!1},name:{type:j.String_unsecure(),isOptional:!0},description:{type:j.String_unsecure(),isOptional:!0},category:{type:j.String_unsecure(),isOptional:!0},isActive:{type:j.Boolean(),isOptional:!0},metadata:{type:j.JSON(),isOptional:!0}}}),V=k({name:"DeleteMetricInput",description:"Input for deleting a metric",fields:{metricId:{type:j.String_unsecure(),isOptional:!1}}}),X=k({name:"GetMetricInput",description:"Input for getting a metric",fields:{key:{type:j.String_unsecure(),isOptional:!1},orgId:{type:j.String_unsecure(),isOptional:!0}}}),Y=k({name:"ListMetricsInput",description:"Input for listing metrics",fields:{orgId:{type:j.String_unsecure(),isOptional:!0},category:{type:j.String_unsecure(),isOptional:!0},isActive:{type:j.Boolean(),isOptional:!0},limit:{type:j.Int_unsecure(),isOptional:!0},offset:{type:j.Int_unsecure(),isOptional:!0}}}),Z=k({name:"ListMetricsOutput",description:"Output for listing metrics",fields:{metrics:{type:x,isArray:!0,isOptional:!1},total:{type:j.Int_unsecure(),isOptional:!1}}}),F=k({name:"RecordUsageInput",description:"Input for recording usage",fields:{metricKey:{type:j.String_unsecure(),isOptional:!1},subjectType:{type:j.String_unsecure(),isOptional:!1},subjectId:{type:j.String_unsecure(),isOptional:!1},quantity:{type:j.Float_unsecure(),isOptional:!1},timestamp:{type:j.DateTime(),isOptional:!0},source:{type:j.String_unsecure(),isOptional:!0},resourceId:{type:j.String_unsecure(),isOptional:!0},resourceType:{type:j.String_unsecure(),isOptional:!0},metadata:{type:j.JSON(),isOptional:!0},idempotencyKey:{type:j.String_unsecure(),isOptional:!0}}}),_=k({name:"RecordBatchUsageInput",description:"Input for recording batch usage",fields:{records:{type:F,isArray:!0,isOptional:!1}}}),$=k({name:"RecordBatchUsageOutput",description:"Output for recording batch usage",fields:{recordedCount:{type:j.Int_unsecure(),isOptional:!1},skippedCount:{type:j.Int_unsecure(),isOptional:!1},recordIds:{type:j.JSON(),isOptional:!1}}}),b=k({name:"GetUsageInput",description:"Input for getting usage",fields:{metricKey:{type:j.String_unsecure(),isOptional:!1},subjectType:{type:j.String_unsecure(),isOptional:!1},subjectId:{type:j.String_unsecure(),isOptional:!1},startDate:{type:j.DateTime(),isOptional:!1},endDate:{type:j.DateTime(),isOptional:!1},limit:{type:j.Int_unsecure(),isOptional:!0},offset:{type:j.Int_unsecure(),isOptional:!0}}}),B=k({name:"GetUsageOutput",description:"Output for getting usage",fields:{records:{type:A,isArray:!0,isOptional:!1},total:{type:j.Int_unsecure(),isOptional:!1},totalQuantity:{type:j.Float_unsecure(),isOptional:!1}}}),L=k({name:"GetUsageSummaryInput",description:"Input for getting usage summary",fields:{metricKey:{type:j.String_unsecure(),isOptional:!1},subjectType:{type:j.String_unsecure(),isOptional:!1},subjectId:{type:j.String_unsecure(),isOptional:!1},periodType:{type:j.String_unsecure(),isOptional:!1},startDate:{type:j.DateTime(),isOptional:!1},endDate:{type:j.DateTime(),isOptional:!0}}}),G=k({name:"GetUsageSummaryOutput",description:"Output for getting usage summary",fields:{summaries:{type:J,isArray:!0,isOptional:!1},total:{type:j.Int_unsecure(),isOptional:!1}}}),Q=k({name:"CreateThresholdInput",description:"Input for creating a threshold",fields:{metricKey:{type:j.String_unsecure(),isOptional:!1},subjectType:{type:j.String_unsecure(),isOptional:!0},subjectId:{type:j.String_unsecure(),isOptional:!0},name:{type:j.String_unsecure(),isOptional:!1},threshold:{type:j.Float_unsecure(),isOptional:!1},warnThreshold:{type:j.Float_unsecure(),isOptional:!0},periodType:{type:j.String_unsecure(),isOptional:!0},action:{type:j.String_unsecure(),isOptional:!0},notifyEmails:{type:j.JSON(),isOptional:!0},notifyWebhook:{type:j.String_unsecure(),isOptional:!0}}}),D=k({name:"UpdateThresholdInput",description:"Input for updating a threshold",fields:{thresholdId:{type:j.String_unsecure(),isOptional:!1},name:{type:j.String_unsecure(),isOptional:!0},threshold:{type:j.Float_unsecure(),isOptional:!0},warnThreshold:{type:j.Float_unsecure(),isOptional:!0},action:{type:j.String_unsecure(),isOptional:!0},notifyEmails:{type:j.JSON(),isOptional:!0},notifyWebhook:{type:j.String_unsecure(),isOptional:!0},isActive:{type:j.Boolean(),isOptional:!0}}}),C=k({name:"DeleteThresholdInput",description:"Input for deleting a threshold",fields:{thresholdId:{type:j.String_unsecure(),isOptional:!1}}}),N=k({name:"ListThresholdsInput",description:"Input for listing thresholds",fields:{metricKey:{type:j.String_unsecure(),isOptional:!0},subjectType:{type:j.String_unsecure(),isOptional:!0},subjectId:{type:j.String_unsecure(),isOptional:!0},isActive:{type:j.Boolean(),isOptional:!0}}}),W=k({name:"ListThresholdsOutput",description:"Output for listing thresholds",fields:{thresholds:{type:z,isArray:!0,isOptional:!1},total:{type:j.Int_unsecure(),isOptional:!1}}}),H=k({name:"SuccessOutput",description:"Generic success output",fields:{success:{type:j.Boolean(),isOptional:!1}}}),U=v({meta:{key:"metric.define",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","metric","define"],description:"Define a new usage metric.",goal:"Create a new metric for tracking usage.",context:"Called when setting up metering."},io:{input:K,output:x,errors:{METRIC_KEY_EXISTS:{description:"Metric key already exists",http:409,gqlCode:"METRIC_KEY_EXISTS",when:"A metric with this key already exists"}}},policy:{auth:"admin"}}),R=v({meta:{key:"metric.update",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","metric","update"],description:"Update a metric definition.",goal:"Modify metric configuration.",context:"Called when updating metric settings."},io:{input:P,output:x,errors:{METRIC_NOT_FOUND:{description:"Metric does not exist",http:404,gqlCode:"METRIC_NOT_FOUND",when:"Metric ID is invalid"}}},policy:{auth:"admin"}}),O=v({meta:{key:"metric.delete",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","metric","delete"],description:"Delete a metric definition.",goal:"Remove a metric and its data.",context:"Called when removing a metric."},io:{input:V,output:H,errors:{METRIC_NOT_FOUND:{description:"Metric does not exist",http:404,gqlCode:"METRIC_NOT_FOUND",when:"Metric ID is invalid"}}},policy:{auth:"admin"}}),s=w({meta:{key:"metric.get",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","metric","get"],description:"Get a metric by key.",goal:"Retrieve metric definition.",context:"Called to inspect metric details."},io:{input:X,output:x,errors:{METRIC_NOT_FOUND:{description:"Metric does not exist",http:404,gqlCode:"METRIC_NOT_FOUND",when:"Metric key is invalid"}}},policy:{auth:"user"}}),f=w({meta:{key:"metric.list",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","metric","list"],description:"List all metrics.",goal:"View configured metrics.",context:"Called to browse metrics."},io:{input:Y,output:Z},policy:{auth:"user"}}),h=v({meta:{key:"usage.record",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","usage","record"],description:"Record a usage event.",goal:"Track usage for billing and monitoring.",context:"Called when usage occurs."},io:{input:F,output:A,errors:{METRIC_NOT_FOUND:{description:"Metric does not exist",http:404,gqlCode:"METRIC_NOT_FOUND",when:"Metric key is invalid"},DUPLICATE_RECORD:{description:"Record already exists",http:409,gqlCode:"DUPLICATE_RECORD",when:"Idempotency key already used"}}},policy:{auth:"admin"}}),M=v({meta:{key:"usage.recordBatch",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","usage","batch"],description:"Record multiple usage events.",goal:"Efficiently track bulk usage.",context:"Called for batch processing."},io:{input:_,output:$},policy:{auth:"admin"}}),o=w({meta:{key:"usage.get",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","usage","get"],description:"Get usage records for a subject.",goal:"View detailed usage history.",context:"Called to analyze usage."},io:{input:b,output:B},policy:{auth:"user"}}),t=w({meta:{key:"usage.getSummary",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","usage","summary"],description:"Get aggregated usage summary.",goal:"View usage totals for billing.",context:"Called for billing and reporting."},io:{input:L,output:G},policy:{auth:"user"}}),i=v({meta:{key:"threshold.create",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","threshold","create"],description:"Create a usage threshold.",goal:"Set up usage limits and alerts.",context:"Called when configuring limits."},io:{input:Q,output:z,errors:{METRIC_NOT_FOUND:{description:"Metric does not exist",http:404,gqlCode:"METRIC_NOT_FOUND",when:"Metric key is invalid"}}},policy:{auth:"admin"}}),d=v({meta:{key:"threshold.update",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","threshold","update"],description:"Update a threshold.",goal:"Modify threshold configuration.",context:"Called when adjusting limits."},io:{input:D,output:z,errors:{THRESHOLD_NOT_FOUND:{description:"Threshold does not exist",http:404,gqlCode:"THRESHOLD_NOT_FOUND",when:"Threshold ID is invalid"}}},policy:{auth:"admin"}}),y=v({meta:{key:"threshold.delete",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","threshold","delete"],description:"Delete a threshold.",goal:"Remove a usage threshold.",context:"Called when removing limits."},io:{input:C,output:H,errors:{THRESHOLD_NOT_FOUND:{description:"Threshold does not exist",http:404,gqlCode:"THRESHOLD_NOT_FOUND",when:"Threshold ID is invalid"}}},policy:{auth:"admin"}}),T=w({meta:{key:"threshold.list",version:"1.0.0",stability:"stable",owners:[...q],tags:["metering","threshold","list"],description:"List usage thresholds.",goal:"View configured limits.",context:"Called to browse thresholds."},io:{input:N,output:W},policy:{auth:"user"}});export{z as UsageThresholdModel,J as UsageSummaryModel,A as UsageRecordModel,d as UpdateThresholdContract,R as UpdateMetricContract,h as RecordUsageContract,M as RecordBatchUsageContract,x as MetricDefinitionModel,T as ListThresholdsContract,f as ListMetricsContract,t as GetUsageSummaryContract,o as GetUsageContract,s as GetMetricContract,y as DeleteThresholdContract,O as DeleteMetricContract,U as DefineMetricContract,i as CreateThresholdContract};

package/dist/node/docs/index.js

@@ -1,15 +1,4 @@
-// src/docs/metering.docblock.ts
-import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
-var meteringDocBlocks = [
-  {
-    id: "docs.metering.usage",
-    title: "Usage Metering & Billing Core",
-    summary: "Reusable usage/metering layer with metric definitions, usage ingestion, aggregation, thresholds, and alerts for billing or quotas.",
-    kind: "reference",
-    visibility: "public",
-    route: "/docs/metering/usage",
-    tags: ["metering", "usage", "billing", "quotas"],
-    body: `## Capabilities
+import{registerDocBlocks as f}from"@contractspec/lib.contracts-spec/docs";var h=[{id:"docs.metering.usage",title:"Usage Metering & Billing Core",summary:"Reusable usage/metering layer with metric definitions, usage ingestion, aggregation, thresholds, and alerts for billing or quotas.",kind:"reference",visibility:"public",route:"/docs/metering/usage",tags:["metering","usage","billing","quotas"],body:`## Capabilities
 
 - **Entities**: MetricDefinition, UsageRecord, UsageSummary, UsageThreshold, UsageAlert.
 - **Contracts**: define/list metrics; record usage (batch + idempotent); retrieve usage by subject; manage thresholds and alerts.
@@ -34,7 +23,7 @@ var meteringDocBlocks = [
 
 ## Example
 
-${"```"}ts
+\`\`\`ts
 import { meteringSchemaContribution } from '@contractspec/lib.metering';
 import { aggregateUsage } from '@contractspec/lib.metering/aggregation';
 
@@ -49,14 +38,11 @@ await aggregateUsage({
   usage: usageRepository,
   period: 'DAILY',
 });
-${"```"},
+\`\`\`,
 
 ## Guardrails
 
 - Keep metric keys stable; store quantities as decimals for currency/units.
 - Use idempotency keys for external ingestion; avoid PII in metric metadata.
 - Scope by org/user for multi-tenant isolation; emit audit + analytics events on changes.
-`
-  }
-];
-registerDocBlocks(meteringDocBlocks);
+`}];f(h);