@allisall/sdk 0.1.0 → 0.4.0

package/dist/types.d.ts

@@ -1,6 +1,13 @@
 import type { Decimal } from "./decimal.js";
+import type { components, operations } from "./generated/openapi.js";
+type Schemas = components["schemas"];
+/**
+ * The query of one operation, from the generated types. The resource
+ * methods' arguments and the public `…Query` names below both use it.
+ */
+export type QueryOf<K extends keyof operations> = NonNullable<operations[K]["parameters"]["query"]>;
 /** The known request-level error codes, in the API's catalogue order. */
-export declare const ERROR_CODES: readonly ["invalid_json", "validation_failed", "unauthenticated", "insufficient_scope", "session_required", "account_not_provisioned", "not_found", "no_active_value_model", "method_not_allowed", "idempotency_key_in_use", "client_key_in_use", "agent_key_in_use", "client_has_events", "client_has_calculations", "agent_has_events", "client_key_has_events", "value_model_exists", "value_model_version_stale", "calculation_transition_invalid", "calculation_not_draft", "calculation_not_published", "report_shared", "report_not_shared", "api_key_revoked", "payload_too_large", "uri_too_long", "unsupported_media_type", "idempotency_key_reused", "rate_limited", "internal_error"];
+export declare const ERROR_CODES: readonly ["invalid_json", "validation_failed", "unauthenticated", "insufficient_scope", "session_required", "account_not_provisioned", "not_found", "no_active_value_model", "method_not_allowed", "idempotency_key_in_use", "client_key_in_use", "agent_key_in_use", "client_has_events", "client_has_calculations", "agent_has_events", "client_key_has_events", "value_model_exists", "value_model_version_stale", "calculation_transition_invalid", "calculation_not_draft", "calculation_not_published", "report_shared", "report_not_shared", "api_key_revoked", "invite_expired", "invite_used", "invite_revoked", "invite_email_mismatch", "email_has_workspace", "payload_too_large", "uri_too_long", "unsupported_media_type", "idempotency_key_reused", "rate_limited", "internal_error", "upstream_failed"];
 /** The known field-level error codes, in the API's catalogue order. */
 export declare const FIELD_ERROR_CODES: readonly ["required", "unknown_field", "immutable", "invalid_type", "invalid_format", "invalid_value", "too_long", "too_many", "out_of_range", "too_precise", "duplicate", "too_large", "mutually_exclusive", "unknown_reference", "client_key_required", "currency_mismatch"];
 /** The event categories. */
@@ -87,9 +94,17 @@ export interface IngestSummary {
     duplicates: number;
     /** Events refused, counted once each, including any too large to send. */
     rejected: number;
-    /** One entry per problem, in the order of the list passed to `ingest`. */
+    /**
+     * One entry per problem, in the order of the list passed to `ingest`.
+     * When `errors_truncated` is `true`, some problems have no entry, and a
+     * rejected event may have none.
+     */
     errors: IngestRowError[];
-    /** Whether any rejected row had more problems than `errors` holds. */
+    /**
+     * Whether `errors` omits any problem. The API lists at most 20 problems
+     * of one event, and at most 1,000,000 bytes of entries for one batch. The
+     * counts always cover every event.
+     */
     errors_truncated: boolean;
     /** The number of batches sent. */
     batches: number;
@@ -133,3 +148,148 @@ export interface Problem {
     /** Every problem found. Present only with `validation_failed`. */
     errors?: FieldError[];
 }
+export type Period = Schemas["Period"];
+export type PeriodInput = Schemas["PeriodInput"];
+export type ClientStatus = Schemas["ClientStatus"];
+export type AgentStatus = Schemas["AgentStatus"];
+export type ValueModelStatus = Schemas["ValueModelStatus"];
+export type CalculationState = Schemas["CalculationState"];
+export type ReportState = Schemas["ReportState"];
+export type RenewalTerm = Schemas["RenewalTerm"];
+export type RenewalTermFilter = Schemas["RenewalTermFilter"];
+export type RenewalWindow = Schemas["RenewalWindow"];
+export type Scope = Schemas["Scope"];
+export type CostTargetKind = Schemas["CostTargetKind"];
+export type EventSource = Schemas["EventSource"];
+export type UndefinedReason = Schemas["UndefinedReason"];
+export type DisclosureKind = Schemas["DisclosureKind"];
+export type PortfolioExclusionReason = Schemas["PortfolioExclusionReason"];
+export type HealthDirection = Schemas["HealthDirection"];
+export type HealthUnavailable = Schemas["HealthUnavailable"];
+export type Client = Schemas["Client"];
+export type AssignedAgent = Schemas["AssignedAgent"];
+export type ClientDetail = Schemas["ClientDetail"];
+export type ClientCreate = Schemas["ClientCreate"];
+export type ClientPatch = Schemas["ClientPatch"];
+export type ClientAgentsSet = Schemas["ClientAgentsSet"];
+export type ClientAgents = Schemas["ClientAgents"];
+export type Agent = Schemas["Agent"];
+export type AgentListItem = Schemas["AgentListItem"];
+export type AgentStats = Schemas["AgentStats"];
+export type AgentDetail = Schemas["AgentDetail"];
+export type AgentCreate = Schemas["AgentCreate"];
+export type AgentPatch = Schemas["AgentPatch"];
+export type ValueLineItem = Schemas["ValueLineItem"];
+export type ValueModel = Schemas["ValueModel"];
+export type ValueModelSummary = Schemas["ValueModelSummary"];
+export type ValueModelCreate = Schemas["ValueModelCreate"];
+export type ValueModelPatch = Schemas["ValueModelPatch"];
+export type ValueLineItemInput = Schemas["ValueLineItemInput"];
+export type ValueLineItemsSet = Schemas["ValueLineItemsSet"];
+export type ValueTemplateLineItem = Schemas["ValueTemplateLineItem"];
+export type ValueTemplate = Schemas["ValueTemplate"];
+export type OutcomeTypeUsage = Schemas["OutcomeTypeUsage"];
+export type CostTarget = Schemas["CostTarget"];
+export type CostTargetInput = Schemas["CostTargetInput"];
+export type CostLineItem = Schemas["CostLineItem"];
+export type CostLineItemCreate = Schemas["CostLineItemCreate"];
+export type CostLineItemPatch = Schemas["CostLineItemPatch"];
+export type ModelRate = Schemas["ModelRate"];
+export type PriceTable = Schemas["PriceTable"];
+export type ModelRateInput = Schemas["ModelRateInput"];
+export type PriceTableSet = Schemas["PriceTableSet"];
+export type Ratios = Schemas["Ratios"];
+export type ValueModelRef = Schemas["ValueModelRef"];
+export type ValueLine = Schemas["ValueLine"];
+export type ValueCoverage = Schemas["ValueCoverage"];
+export type ValueResult = Schemas["ValueResult"];
+export type ManualCostLine = Schemas["ManualCostLine"];
+export type TokenCostLine = Schemas["TokenCostLine"];
+export type AgentCostLine = Schemas["AgentCostLine"];
+export type UnattributedLineItem = Schemas["UnattributedLineItem"];
+export type CostCoverage = Schemas["CostCoverage"];
+export type CostResult = Schemas["CostResult"];
+export type ClientValue = Schemas["ClientValue"];
+export type ClientCost = Schemas["ClientCost"];
+export type RoiResult = Schemas["RoiResult"];
+export type Anomalies = Schemas["Anomalies"];
+export type AttributedEvent = Schemas["AttributedEvent"];
+export type ClientEventList = Schemas["ClientEventList"];
+export type EventList = Schemas["EventList"];
+export type EventSummary = Schemas["EventSummary"];
+export type EventDayCount = Schemas["EventDayCount"];
+export type EventCategoryCount = Schemas["EventCategoryCount"];
+export type EventArrivalList = Schemas["EventArrivalList"];
+export type Checklist = Schemas["Checklist"];
+export type ChecklistInput = Schemas["ChecklistInput"];
+export type CalculationSnapshot = Schemas["CalculationSnapshot"];
+export type Calculation = Schemas["Calculation"];
+export type CalculationSummary = Schemas["CalculationSummary"];
+export type CalculationCreate = Schemas["CalculationCreate"];
+export type Disclosure = Schemas["Disclosure"];
+export type DisclosureEdit = Schemas["DisclosureEdit"];
+export type Report = Schemas["Report"];
+export type ReportSummary = Schemas["ReportSummary"];
+export type ReportWithPreview = Schemas["ReportWithPreview"];
+export type ReportPatch = Schemas["ReportPatch"];
+export type PublicReport = Schemas["PublicReport"];
+export type PortfolioClient = Schemas["PortfolioClient"];
+export type Dashboard = Schemas["Dashboard"];
+export type Renewal = Schemas["Renewal"];
+export type ApiKey = Schemas["ApiKey"];
+export type ApiKeyWithToken = Schemas["ApiKeyWithToken"];
+export type ApiKeyCreate = Schemas["ApiKeyCreate"];
+export type ImportMapping = Schemas["ImportMapping"];
+export type ImportRowError = Schemas["ImportRowError"];
+export type PreviewEvent = Schemas["PreviewEvent"];
+export type PreviewRow = Schemas["PreviewRow"];
+export type ImportPreview = Schemas["ImportPreview"];
+export type ImportResult = Schemas["ImportResult"];
+export type ImportSummary = Schemas["ImportSummary"];
+export type Import = Schemas["Import"];
+export type AppliedImportMapping = Schemas["AppliedImportMapping"];
+export type ImportDelimiter = Schemas["ImportDelimiter"];
+export type Health = Schemas["Health"];
+export type ImportList = Schemas["ImportList"];
+export type ClientList = Schemas["ClientList"];
+export type AgentList = Schemas["AgentList"];
+export type ValueModelList = Schemas["ValueModelList"];
+export type OutcomeTypeList = Schemas["OutcomeTypeList"];
+export type ValueTemplateList = Schemas["ValueTemplateList"];
+export type CostLineItemList = Schemas["CostLineItemList"];
+export type CalculationList = Schemas["CalculationList"];
+export type ReportList = Schemas["ReportList"];
+export type WorkspaceCalculationList = Schemas["WorkspaceCalculationList"];
+export type WorkspaceReportList = Schemas["WorkspaceReportList"];
+export type RenewalList = Schemas["RenewalList"];
+export type ApiKeyList = Schemas["ApiKeyList"];
+export type Workspace = Schemas["Workspace"];
+export type OnboardingStep = Schemas["OnboardingStep"];
+export type OnboardingStepProgress = Schemas["OnboardingStepProgress"];
+export type Onboarding = Schemas["Onboarding"];
+export type OnboardingSkippedStepsSet = Schemas["OnboardingSkippedStepsSet"];
+export type ListEventsQuery = QueryOf<"listEvents">;
+export type GetEventSummaryQuery = QueryOf<"getEventSummary">;
+export type ListEventArrivalsQuery = QueryOf<"listEventArrivals">;
+export type ListImportsQuery = QueryOf<"listImports">;
+export type ListClientsQuery = QueryOf<"listClients">;
+export type ListClientOutcomeTypesQuery = QueryOf<"listClientOutcomeTypes">;
+export type GetClientValueQuery = QueryOf<"getClientValue">;
+export type GetClientCostQuery = QueryOf<"getClientCost">;
+export type GetClientRoiQuery = QueryOf<"getClientRoi">;
+export type ListClientEventsQuery = QueryOf<"listClientEvents">;
+export type ListClientCalculationsQuery = QueryOf<"listClientCalculations">;
+export type GetClientAnomaliesQuery = QueryOf<"getClientAnomalies">;
+export type ListAgentsQuery = QueryOf<"listAgents">;
+export type GetAgentQuery = QueryOf<"getAgent">;
+export type ListValueModelsQuery = QueryOf<"listValueModels">;
+export type ListOutcomeTypesQuery = QueryOf<"listOutcomeTypes">;
+export type ListValueTemplatesQuery = QueryOf<"listValueTemplates">;
+export type ListCostLineItemsQuery = QueryOf<"listCostLineItems">;
+export type ListCalculationsQuery = QueryOf<"listCalculations">;
+export type ListCalculationReportsQuery = QueryOf<"listCalculationReports">;
+export type ListReportsQuery = QueryOf<"listReports">;
+export type GetDashboardQuery = QueryOf<"getDashboard">;
+export type ListRenewalsQuery = QueryOf<"listRenewals">;
+export type ListApiKeysQuery = QueryOf<"listApiKeys">;
+export {};

package/dist/types.js

@@ -1,6 +1,15 @@
-// The wire types the SDK uses, written by hand from the API's OpenAPI
-// document. A test reads that document and holds every list below to it,
-// until types generated from the document replace this file.
+// The public names of the wire types.
+//
+// Most are aliases of the types generated from the API's OpenAPI document,
+// one per schema, under the schema's own name. The scalar schemas, such as
+// `Money` and `Instant`, are not exported: each is a `string`, a `number` or
+// a `Decimal`, and an exported `Date` would shadow the global one.
+//
+// The names this SDK exported before the generated types existed keep their
+// hand-written definitions below: `ErrorCode`, `FieldErrorCode`,
+// `EventCategory`, `EventInput`, `FieldError`, `Problem` and
+// `IngestRowError`. A test holds each to the generated type it corresponds
+// to, and reads the document to hold every list below to it.
 /** The known request-level error codes, in the API's catalogue order. */
 export const ERROR_CODES = [
     "invalid_json",
@@ -27,12 +36,18 @@ export const ERROR_CODES = [
     "report_shared",
     "report_not_shared",
     "api_key_revoked",
+    "invite_expired",
+    "invite_used",
+    "invite_revoked",
+    "invite_email_mismatch",
+    "email_has_workspace",
     "payload_too_large",
     "uri_too_long",
     "unsupported_media_type",
     "idempotency_key_reused",
     "rate_limited",
     "internal_error",
+    "upstream_failed",
 ];
 /** The known field-level error codes, in the API's catalogue order. */
 export const FIELD_ERROR_CODES = [

package/dist/unicode.d.ts

@@ -0,0 +1,2 @@
+/** Whether `text` holds a UTF-16 surrogate without its partner. */
+export declare function hasLoneSurrogate(text: string): boolean;

package/dist/unicode.js

@@ -0,0 +1,11 @@
+// Text that UTF-8 cannot encode. A JavaScript string is UTF-16, so it can
+// hold a surrogate without its partner. JSON.stringify writes one as an
+// escape such as \ud800, and a URL or form writes it as U+FFFD; either way
+// the API stores a character the caller never sent.
+// A high surrogate not followed by a low one, or a low one not preceded by
+// a high one.
+const LONE_SURROGATE = /[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]/;
+/** Whether `text` holds a UTF-16 surrogate without its partner. */
+export function hasLoneSurrogate(text) {
+    return LONE_SURROGATE.test(text);
+}

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** The SDK's version. The release tooling updates it; never edit it by hand. */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.4.0";

package/dist/version.js

@@ -1,2 +1,2 @@
 /** The SDK's version. The release tooling updates it; never edit it by hand. */
-export const VERSION = "0.1.0"; // x-release-please-version
+export const VERSION = "0.4.0"; // x-release-please-version

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@allisall/sdk",
-  "version": "0.1.0",
-  "description": "The allisall SDK for TypeScript and JavaScript: send events to the allisall API.",
+  "version": "0.4.0",
+  "description": "The allisall SDK for TypeScript and JavaScript: a typed client for the allisall API, from sending events to publishing reports.",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -28,11 +28,12 @@
     "build": "tsc -p tsconfig.build.json",
     "lint": "biome check . && tsc --noEmit -p tsconfig.json",
     "test": "vitest run && npm run test:consumer",
-    "test:consumer": "tsc -p tsconfig.build.json && node test/consumer/extract-readme.mjs && node node_modules/typescript-5.0/bin/tsc -p test/consumer/tsconfig.bundler.json && node node_modules/typescript-5.0/bin/tsc -p test/consumer/tsconfig.node16.json && node node_modules/typescript-5.0/bin/tsc -p test/consumer/tsconfig.node-types.json"
+    "test:consumer": "tsc -p tsconfig.build.json && node test/consumer/extract-readme.mjs && node node_modules/typescript-5.0/bin/tsc -p test/consumer/tsconfig.bundler.json && node node_modules/typescript-5.0/bin/tsc -p test/consumer/tsconfig.node16.json && node node_modules/typescript-5.0/bin/tsc -p test/consumer/tsconfig.node-types.json && tsc -p test/consumer/tsconfig.examples.json"
   },
   "devDependencies": {
     "@biomejs/biome": "2.5.4",
     "@types/node": "^22.20.5",
+    "openapi-typescript": "7.13.0",
     "typescript": "~5.9.3",
     "typescript-5.0": "npm:typescript@5.0.4",
     "vitest": "^4.1.10",