@lssm/lib.metering 0.0.0-canary-20251206160926

package/dist/contracts/index.js

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

package/dist/entities/index.d.ts

@@ -0,0 +1,230 @@
+import * as _lssm_lib_schema133 from "@lssm/lib.schema";
+import { ModuleSchemaContribution } from "@lssm/lib.schema";
+
+//#region src/entities/index.d.ts
+/**
+ * Aggregation type enum.
+ */
+declare const AggregationTypeEnum: _lssm_lib_schema133.EntityEnumDef;
+/**
+ * Reset period enum.
+ */
+declare const ResetPeriodEnum: _lssm_lib_schema133.EntityEnumDef;
+/**
+ * Period type enum.
+ */
+declare const PeriodTypeEnum: _lssm_lib_schema133.EntityEnumDef;
+/**
+ * Threshold action enum.
+ */
+declare const ThresholdActionEnum: _lssm_lib_schema133.EntityEnumDef;
+/**
+ * MetricDefinition entity - defines a trackable metric.
+ */
+declare const MetricDefinitionEntity: _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  key: _lssm_lib_schema133.EntityScalarField;
+  name: _lssm_lib_schema133.EntityScalarField;
+  description: _lssm_lib_schema133.EntityScalarField;
+  unit: _lssm_lib_schema133.EntityScalarField;
+  aggregationType: _lssm_lib_schema133.EntityEnumField;
+  resetPeriod: _lssm_lib_schema133.EntityEnumField;
+  precision: _lssm_lib_schema133.EntityScalarField;
+  orgId: _lssm_lib_schema133.EntityScalarField;
+  category: _lssm_lib_schema133.EntityScalarField;
+  displayOrder: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  isActive: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  updatedAt: _lssm_lib_schema133.EntityScalarField;
+  usageRecords: _lssm_lib_schema133.EntityRelationField;
+  usageSummaries: _lssm_lib_schema133.EntityRelationField;
+  thresholds: _lssm_lib_schema133.EntityRelationField;
+}>;
+/**
+ * UsageRecord entity - individual usage event.
+ */
+declare const UsageRecordEntity: _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  metricId: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  quantity: _lssm_lib_schema133.EntityScalarField;
+  source: _lssm_lib_schema133.EntityScalarField;
+  resourceId: _lssm_lib_schema133.EntityScalarField;
+  resourceType: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  idempotencyKey: _lssm_lib_schema133.EntityScalarField;
+  timestamp: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  aggregated: _lssm_lib_schema133.EntityScalarField;
+  aggregatedAt: _lssm_lib_schema133.EntityScalarField;
+}>;
+/**
+ * UsageSummary entity - pre-aggregated usage.
+ */
+declare const UsageSummaryEntity: _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  metricId: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  periodType: _lssm_lib_schema133.EntityEnumField;
+  periodStart: _lssm_lib_schema133.EntityScalarField;
+  periodEnd: _lssm_lib_schema133.EntityScalarField;
+  totalQuantity: _lssm_lib_schema133.EntityScalarField;
+  recordCount: _lssm_lib_schema133.EntityScalarField;
+  minQuantity: _lssm_lib_schema133.EntityScalarField;
+  maxQuantity: _lssm_lib_schema133.EntityScalarField;
+  avgQuantity: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  updatedAt: _lssm_lib_schema133.EntityScalarField;
+}>;
+/**
+ * UsageThreshold entity - threshold configuration.
+ */
+declare const UsageThresholdEntity: _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  metricId: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  name: _lssm_lib_schema133.EntityScalarField;
+  threshold: _lssm_lib_schema133.EntityScalarField;
+  warnThreshold: _lssm_lib_schema133.EntityScalarField;
+  periodType: _lssm_lib_schema133.EntityEnumField;
+  action: _lssm_lib_schema133.EntityEnumField;
+  notifyEmails: _lssm_lib_schema133.EntityScalarField;
+  notifyWebhook: _lssm_lib_schema133.EntityScalarField;
+  currentValue: _lssm_lib_schema133.EntityScalarField;
+  lastCheckedAt: _lssm_lib_schema133.EntityScalarField;
+  lastExceededAt: _lssm_lib_schema133.EntityScalarField;
+  isActive: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  updatedAt: _lssm_lib_schema133.EntityScalarField;
+}>;
+/**
+ * UsageAlert entity - threshold violation alerts.
+ */
+declare const UsageAlertEntity: _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  thresholdId: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  alertType: _lssm_lib_schema133.EntityScalarField;
+  threshold: _lssm_lib_schema133.EntityScalarField;
+  actualValue: _lssm_lib_schema133.EntityScalarField;
+  percentageUsed: _lssm_lib_schema133.EntityScalarField;
+  status: _lssm_lib_schema133.EntityScalarField;
+  acknowledgedBy: _lssm_lib_schema133.EntityScalarField;
+  acknowledgedAt: _lssm_lib_schema133.EntityScalarField;
+  resolvedAt: _lssm_lib_schema133.EntityScalarField;
+  notificationsSent: _lssm_lib_schema133.EntityScalarField;
+  triggeredAt: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  thresholdRelation: _lssm_lib_schema133.EntityRelationField;
+}>;
+/**
+ * All metering entities for schema composition.
+ */
+declare const meteringEntities: (_lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  key: _lssm_lib_schema133.EntityScalarField;
+  name: _lssm_lib_schema133.EntityScalarField;
+  description: _lssm_lib_schema133.EntityScalarField;
+  unit: _lssm_lib_schema133.EntityScalarField;
+  aggregationType: _lssm_lib_schema133.EntityEnumField;
+  resetPeriod: _lssm_lib_schema133.EntityEnumField;
+  precision: _lssm_lib_schema133.EntityScalarField;
+  orgId: _lssm_lib_schema133.EntityScalarField;
+  category: _lssm_lib_schema133.EntityScalarField;
+  displayOrder: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  isActive: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  updatedAt: _lssm_lib_schema133.EntityScalarField;
+  usageRecords: _lssm_lib_schema133.EntityRelationField;
+  usageSummaries: _lssm_lib_schema133.EntityRelationField;
+  thresholds: _lssm_lib_schema133.EntityRelationField;
+}> | _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  metricId: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  quantity: _lssm_lib_schema133.EntityScalarField;
+  source: _lssm_lib_schema133.EntityScalarField;
+  resourceId: _lssm_lib_schema133.EntityScalarField;
+  resourceType: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  idempotencyKey: _lssm_lib_schema133.EntityScalarField;
+  timestamp: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  aggregated: _lssm_lib_schema133.EntityScalarField;
+  aggregatedAt: _lssm_lib_schema133.EntityScalarField;
+}> | _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  metricId: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  periodType: _lssm_lib_schema133.EntityEnumField;
+  periodStart: _lssm_lib_schema133.EntityScalarField;
+  periodEnd: _lssm_lib_schema133.EntityScalarField;
+  totalQuantity: _lssm_lib_schema133.EntityScalarField;
+  recordCount: _lssm_lib_schema133.EntityScalarField;
+  minQuantity: _lssm_lib_schema133.EntityScalarField;
+  maxQuantity: _lssm_lib_schema133.EntityScalarField;
+  avgQuantity: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  updatedAt: _lssm_lib_schema133.EntityScalarField;
+}> | _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  metricId: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  name: _lssm_lib_schema133.EntityScalarField;
+  threshold: _lssm_lib_schema133.EntityScalarField;
+  warnThreshold: _lssm_lib_schema133.EntityScalarField;
+  periodType: _lssm_lib_schema133.EntityEnumField;
+  action: _lssm_lib_schema133.EntityEnumField;
+  notifyEmails: _lssm_lib_schema133.EntityScalarField;
+  notifyWebhook: _lssm_lib_schema133.EntityScalarField;
+  currentValue: _lssm_lib_schema133.EntityScalarField;
+  lastCheckedAt: _lssm_lib_schema133.EntityScalarField;
+  lastExceededAt: _lssm_lib_schema133.EntityScalarField;
+  isActive: _lssm_lib_schema133.EntityScalarField;
+  metadata: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  updatedAt: _lssm_lib_schema133.EntityScalarField;
+}> | _lssm_lib_schema133.EntitySpec<{
+  id: _lssm_lib_schema133.EntityScalarField;
+  thresholdId: _lssm_lib_schema133.EntityScalarField;
+  metricKey: _lssm_lib_schema133.EntityScalarField;
+  subjectType: _lssm_lib_schema133.EntityScalarField;
+  subjectId: _lssm_lib_schema133.EntityScalarField;
+  alertType: _lssm_lib_schema133.EntityScalarField;
+  threshold: _lssm_lib_schema133.EntityScalarField;
+  actualValue: _lssm_lib_schema133.EntityScalarField;
+  percentageUsed: _lssm_lib_schema133.EntityScalarField;
+  status: _lssm_lib_schema133.EntityScalarField;
+  acknowledgedBy: _lssm_lib_schema133.EntityScalarField;
+  acknowledgedAt: _lssm_lib_schema133.EntityScalarField;
+  resolvedAt: _lssm_lib_schema133.EntityScalarField;
+  notificationsSent: _lssm_lib_schema133.EntityScalarField;
+  triggeredAt: _lssm_lib_schema133.EntityScalarField;
+  createdAt: _lssm_lib_schema133.EntityScalarField;
+  thresholdRelation: _lssm_lib_schema133.EntityRelationField;
+}>)[];
+/**
+ * Module schema contribution for metering.
+ */
+declare const meteringSchemaContribution: ModuleSchemaContribution;
+//#endregion
+export { AggregationTypeEnum, MetricDefinitionEntity, PeriodTypeEnum, ResetPeriodEnum, ThresholdActionEnum, UsageAlertEntity, UsageRecordEntity, UsageSummaryEntity, UsageThresholdEntity, meteringEntities, meteringSchemaContribution };

package/dist/entities/index.js

@@ -0,0 +1 @@
+import{i as e,n as t,r as n,t as r}from"../schema/dist/entity/defineEntity.js";import"../schema/dist/index.js";const i=t({name:`AggregationType`,values:[`COUNT`,`SUM`,`AVG`,`MAX`,`MIN`,`LAST`],schema:`lssm_metering`,description:`How to aggregate metric values.`}),a=t({name:`ResetPeriod`,values:[`NEVER`,`HOURLY`,`DAILY`,`WEEKLY`,`MONTHLY`,`YEARLY`],schema:`lssm_metering`,description:`When to reset metric counters.`}),o=t({name:`PeriodType`,values:[`HOURLY`,`DAILY`,`WEEKLY`,`MONTHLY`,`YEARLY`],schema:`lssm_metering`,description:`Time period for aggregation.`}),s=t({name:`ThresholdAction`,values:[`NONE`,`ALERT`,`WARN`,`BLOCK`,`DOWNGRADE`],schema:`lssm_metering`,description:`Action to take when threshold is exceeded.`}),c=r({name:`MetricDefinition`,description:`Definition of a usage metric.`,schema:`lssm_metering`,map:`metric_definition`,fields:{id:n.id({description:`Unique identifier`}),key:n.string({isUnique:!0,description:`Metric key (e.g., api_calls, storage_gb)`}),name:n.string({description:`Human-readable name`}),description:n.string({isOptional:!0,description:`Metric description`}),unit:n.string({description:`Unit of measurement (calls, bytes, etc.)`}),aggregationType:n.enum(`AggregationType`,{default:`SUM`,description:`How to aggregate values`}),resetPeriod:n.enum(`ResetPeriod`,{default:`MONTHLY`,description:`When to reset counters`}),precision:n.int({default:2,description:`Decimal precision`}),orgId:n.string({isOptional:!0,description:`Organization scope (null = global metric)`}),category:n.string({isOptional:!0,description:`Category for grouping`}),displayOrder:n.int({default:0,description:`Order for display`}),metadata:n.json({isOptional:!0,description:`Additional metadata`}),isActive:n.boolean({default:!0,description:`Whether metric is active`}),createdAt:n.createdAt(),updatedAt:n.updatedAt(),usageRecords:n.hasMany(`UsageRecord`),usageSummaries:n.hasMany(`UsageSummary`),thresholds:n.hasMany(`UsageThreshold`)},indexes:[e.on([`orgId`,`key`]),e.on([`category`]),e.on([`isActive`])],enums:[i,a]}),l=r({name:`UsageRecord`,description:`A single usage event.`,schema:`lssm_metering`,map:`usage_record`,fields:{id:n.id({description:`Unique identifier`}),metricKey:n.string({description:`Metric being recorded`}),metricId:n.string({isOptional:!0,description:`Metric ID (for FK)`}),subjectType:n.string({description:`Subject type (org, user, project)`}),subjectId:n.string({description:`Subject identifier`}),quantity:n.decimal({description:`Usage quantity`}),source:n.string({isOptional:!0,description:`Source of usage (endpoint, feature, etc.)`}),resourceId:n.string({isOptional:!0,description:`Related resource ID`}),resourceType:n.string({isOptional:!0,description:`Related resource type`}),metadata:n.json({isOptional:!0,description:`Additional context`}),idempotencyKey:n.string({isOptional:!0,description:`Idempotency key for deduplication`}),timestamp:n.dateTime({description:`When usage occurred`}),createdAt:n.createdAt(),aggregated:n.boolean({default:!1,description:`Whether included in summary`}),aggregatedAt:n.dateTime({isOptional:!0,description:`When aggregated`})},indexes:[e.on([`metricKey`,`subjectType`,`subjectId`,`timestamp`]),e.on([`subjectType`,`subjectId`,`timestamp`]),e.on([`timestamp`]),e.on([`aggregated`,`timestamp`]),e.unique([`idempotencyKey`],{name:`usage_record_idempotency`})]}),u=r({name:`UsageSummary`,description:`Pre-aggregated usage summary.`,schema:`lssm_metering`,map:`usage_summary`,fields:{id:n.id({description:`Unique identifier`}),metricKey:n.string({description:`Metric key`}),metricId:n.string({isOptional:!0,description:`Metric ID (for FK)`}),subjectType:n.string({description:`Subject type`}),subjectId:n.string({description:`Subject identifier`}),periodType:n.enum(`PeriodType`,{description:`Period type`}),periodStart:n.dateTime({description:`Period start time`}),periodEnd:n.dateTime({description:`Period end time`}),totalQuantity:n.decimal({description:`Total/aggregated quantity`}),recordCount:n.int({default:0,description:`Number of records aggregated`}),minQuantity:n.decimal({isOptional:!0,description:`Minimum value`}),maxQuantity:n.decimal({isOptional:!0,description:`Maximum value`}),avgQuantity:n.decimal({isOptional:!0,description:`Average value`}),metadata:n.json({isOptional:!0,description:`Additional metadata`}),createdAt:n.createdAt(),updatedAt:n.updatedAt()},indexes:[e.unique([`metricKey`,`subjectType`,`subjectId`,`periodType`,`periodStart`],{name:`usage_summary_unique`}),e.on([`subjectType`,`subjectId`,`periodType`,`periodStart`]),e.on([`metricKey`,`periodType`,`periodStart`])],enums:[o]}),d=r({name:`UsageThreshold`,description:`Usage threshold configuration.`,schema:`lssm_metering`,map:`usage_threshold`,fields:{id:n.id({description:`Unique identifier`}),metricKey:n.string({description:`Metric to monitor`}),metricId:n.string({isOptional:!0,description:`Metric ID (for FK)`}),subjectType:n.string({isOptional:!0,description:`Subject type`}),subjectId:n.string({isOptional:!0,description:`Subject identifier`}),name:n.string({description:`Threshold name`}),threshold:n.decimal({description:`Threshold value`}),warnThreshold:n.decimal({isOptional:!0,description:`Warning threshold (e.g., 80%)`}),periodType:n.enum(`PeriodType`,{default:`MONTHLY`,description:`Period to evaluate`}),action:n.enum(`ThresholdAction`,{default:`ALERT`,description:`Action when exceeded`}),notifyEmails:n.json({isOptional:!0,description:`Email addresses to notify`}),notifyWebhook:n.string({isOptional:!0,description:`Webhook URL to call`}),currentValue:n.decimal({default:0,description:`Current usage value`}),lastCheckedAt:n.dateTime({isOptional:!0,description:`Last threshold check`}),lastExceededAt:n.dateTime({isOptional:!0,description:`Last time threshold was exceeded`}),isActive:n.boolean({default:!0,description:`Whether threshold is active`}),metadata:n.json({isOptional:!0,description:`Additional metadata`}),createdAt:n.createdAt(),updatedAt:n.updatedAt()},indexes:[e.on([`metricKey`]),e.on([`subjectType`,`subjectId`]),e.on([`isActive`,`metricKey`])],enums:[s]}),f=r({name:`UsageAlert`,description:`Alert generated when threshold is exceeded.`,schema:`lssm_metering`,map:`usage_alert`,fields:{id:n.id({description:`Unique identifier`}),thresholdId:n.foreignKey({description:`Threshold that triggered alert`}),metricKey:n.string({description:`Metric key`}),subjectType:n.string({isOptional:!0,description:`Subject type`}),subjectId:n.string({isOptional:!0,description:`Subject identifier`}),alertType:n.string({description:`Alert type (warn, exceed, etc.)`}),threshold:n.decimal({description:`Threshold value`}),actualValue:n.decimal({description:`Actual usage value`}),percentageUsed:n.decimal({description:`Percentage of threshold used`}),status:n.string({default:`"pending"`,description:`Alert status (pending, acknowledged, resolved)`}),acknowledgedBy:n.string({isOptional:!0,description:`User who acknowledged`}),acknowledgedAt:n.dateTime({isOptional:!0,description:`When acknowledged`}),resolvedAt:n.dateTime({isOptional:!0,description:`When resolved`}),notificationsSent:n.json({isOptional:!0,description:`Notifications sent`}),triggeredAt:n.dateTime({description:`When alert was triggered`}),createdAt:n.createdAt(),thresholdRelation:n.belongsTo(`UsageThreshold`,[`thresholdId`],[`id`],{onDelete:`Cascade`})},indexes:[e.on([`thresholdId`,`status`]),e.on([`metricKey`,`triggeredAt`]),e.on([`status`,`triggeredAt`])]}),p=[c,l,u,d,f],m={moduleId:`@lssm/lib.metering`,entities:p,enums:[i,a,o,s]};export{i as AggregationTypeEnum,c as MetricDefinitionEntity,o as PeriodTypeEnum,a as ResetPeriodEnum,s as ThresholdActionEnum,f as UsageAlertEntity,l as UsageRecordEntity,u as UsageSummaryEntity,d as UsageThresholdEntity,p as meteringEntities,m as meteringSchemaContribution};