@timeback/case 0.1.0

package/dist/factory.d.ts

@@ -0,0 +1,42 @@
+/**
+ * CASE Client Factory
+ *
+ * Creates CaseClient classes bound to specific provider registries.
+ */
+import { AssociationsResource, DocumentsResource, ItemsResource, PackagesResource } from './resources';
+import type { AuthCheckResult, ProviderRegistry, TimebackProvider } from '@timeback/internal-client-infra';
+import type { CaseClientConfig, CaseTransportLike } from './types';
+/**
+ * Create a CaseClient class bound to a specific provider registry.
+ *
+ * @param registry - Provider registry to use (defaults to all Timeback platforms)
+ * @returns CaseClient class bound to the registry
+ */
+export declare function createCaseClient(registry?: ProviderRegistry): {
+    new (config?: CaseClientConfig): {
+        /** @internal */
+        readonly transport: CaseTransportLike;
+        /** @internal */
+        readonly _provider?: TimebackProvider | undefined;
+        /** Query CASE framework documents */
+        readonly documents: DocumentsResource;
+        /** Query CASE framework items (competencies, standards) */
+        readonly items: ItemsResource;
+        /** Query CASE framework associations */
+        readonly associations: AssociationsResource;
+        /** Upload, replace, and retrieve CASE framework packages */
+        readonly packages: PackagesResource;
+        /**
+         * Get the underlying transport for advanced use cases.
+         * @returns The transport instance used by this client
+         */
+        getTransport(): CaseTransportLike;
+        /**
+         * Verify that OAuth authentication is working.
+         * @returns Auth check result
+         * @throws {Error} If client was initialized with custom transport (no provider)
+         */
+        checkAuth(): Promise<AuthCheckResult>;
+    };
+};
+//# sourceMappingURL=factory.d.ts.map

package/dist/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGtG,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAC1G,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAElE;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,GAAE,gBAA4C;;QAErF,gBAAgB;;QAGhB,gBAAgB;;QAGhB,qCAAqC;;QAErC,2DAA2D;;QAE3D,wCAAwC;;QAExC,4DAA4D;;QA4C5D;;;WAGG;;QAKH;;;;WAIG;;;EASJ"}

package/dist/index.d.ts

@@ -0,0 +1,560 @@
+import * as _timeback_internal_client_infra from '@timeback/internal-client-infra';
+import { ClientConfig, TransportOnlyConfig, CasePaths, RequestOptions, PaginatedResponse, ProviderClientConfig, TransportConfigWithTokenProvider, ProviderRegistry, TimebackProvider, AuthCheckResult, BaseTransport } from '@timeback/internal-client-infra';
+export { AuthCheckResult, EnvAuth, Environment, ExplicitAuth } from '@timeback/internal-client-infra';
+
+/**
+ * CASE Base Types
+ *
+ * Shared types for the CASE (Competency and Academic Standards Exchange) v1p1 API.
+ */
+
+/**
+ * URI reference to a CASE entity.
+ *
+ * A common pattern across CASE responses for linking to related entities.
+ */
+interface LinkURI {
+	sourcedId: string
+	title: string
+	uri: string
+}
+
+/**
+ * Optional URI reference (uri may be absent).
+ */
+interface OptionalLinkURI {
+	sourcedId: string
+	title: string
+	uri?: string
+}
+
+/**
+ * CASE Association Types
+ *
+ * Types for CASE Framework Associations (CFAssociations).
+ * A CFAssociation defines a relationship between two CASE entities.
+ */
+
+
+
+/**
+ * A CASE Framework Association.
+ *
+ * Defines a typed relationship between two CASE entities
+ * (e.g., isChildOf, isRelatedTo, precedes).
+ */
+interface CFAssociation {
+	sourcedId: string
+	associationType: string
+	sequenceNumber?: number
+	uri: string
+	originNodeURI: LinkURI
+	destinationNodeURI: LinkURI
+	CFAssociationGroupingURI?: OptionalLinkURI
+	lastChangeDateTime: string
+	notes?: string
+	extensions?: Record<string, unknown>
+	CFDocumentURI?: OptionalLinkURI
+}
+
+/**
+ * CASE Document Types
+ *
+ * Types for CASE Framework Documents (CFDocuments).
+ * A CFDocument represents a curriculum framework or standards document.
+ */
+
+
+
+/**
+ * A CASE Framework Document.
+ *
+ * Represents a curriculum framework or standards document containing
+ * items (competencies/standards) and their associations.
+ */
+interface CFDocument {
+	sourcedId: string
+	title: string
+	uri: string
+	frameworkType?: string
+	caseVersion?: string
+	creator: string
+	lastChangeDateTime: string
+	officialSourceURL?: string
+	publisher?: string
+	description?: string
+	subject?: string[]
+	subjectURI?: OptionalLinkURI[]
+	language?: string
+	version?: string
+	adoptionStatus?: string
+	statusStartDate?: string
+	statusEndDate?: string
+	licenseURI?: OptionalLinkURI
+	notes?: string
+	extensions?: Record<string, unknown>
+	CFPackageURI: LinkURI
+}
+
+/**
+ * CASE Item Types
+ *
+ * Types for CASE Framework Items (CFItems).
+ * A CFItem represents an individual competency, standard, or learning objective.
+ */
+
+
+
+/**
+ * A CASE Framework Item.
+ *
+ * Represents a single competency, standard, or learning objective
+ * within a curriculum framework.
+ */
+interface CFItem {
+	sourcedId: string
+	fullStatement: string
+	alternativeLabel?: string
+	CFItemType: string
+	uri: string
+	humanCodingScheme?: string
+	listEnumeration?: string
+	abbreviatedStatement?: string
+	conceptKeywords?: string[]
+	conceptKeywordsURI?: OptionalLinkURI
+	notes?: string
+	subject?: string[]
+	subjectURI?: OptionalLinkURI[]
+	language?: string
+	educationLevel?: string[]
+	CFItemTypeURI?: OptionalLinkURI
+	licenseURI?: OptionalLinkURI
+	statusStartDate?: string
+	statusEndDate?: string
+	lastChangeDateTime: string
+	extensions?: Record<string, unknown>
+	CFDocumentURI?: OptionalLinkURI
+}
+
+/**
+ * CASE Package Types
+ *
+ * Types for CASE Framework Packages (CFPackages).
+ * A CFPackage is a complete bundle of a document, its items, and associations.
+ */
+
+
+
+/**
+ * A complete CASE Framework Package.
+ *
+ * Bundles a CFDocument with all its CFItems and CFAssociations.
+ */
+interface CFPackage {
+	sourcedId: string
+	CFDocument: CFDocument
+	CFItems?: CFItem[]
+	CFAssociations?: CFAssociation[]
+}
+
+/**
+ * A CASE Framework Package with hierarchical group structure.
+ *
+ * Extends the standard package with a `structuredContent` field
+ * that organizes items into named groups with optional nesting.
+ */
+interface CFPackageWithGroups {
+	sourcedId: string
+	CFDocument: CFDocument
+	structuredContent: Record<string, CFItemWithChildGroups[]>
+}
+
+/**
+ * A CFItem extended with optional child group nesting.
+ */
+interface CFItemWithChildGroups extends CFItem {
+	childGroups?: Record<string, unknown[]>
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// PACKAGE INPUT TYPES (for POST/PUT)
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * URI reference used in package input payloads.
+ *
+ * Package inputs use `identifier` and `uri` instead of `sourcedId`.
+ */
+interface InputNodeURI {
+	title: string
+	identifier: string
+	uri: string
+}
+
+/**
+ * Document definition within a package upload.
+ */
+interface CFDocumentInput {
+	identifier: string
+	uri: string
+	lastChangeDateTime: string
+	title: string
+	creator: string
+	officialSourceURL?: string
+	publisher?: string
+	description?: string
+	language?: string
+	version?: string
+	caseVersion?: string
+	adoptionStatus?: string
+	statusStartDate?: string
+	statusEndDate?: string
+	licenseUri?: string
+	notes?: string
+	subject?: string[]
+	extensions?: unknown
+}
+
+/**
+ * Item definition within a package upload.
+ */
+interface CFItemInput {
+	identifier: string
+	uri: string
+	lastChangeDateTime: string
+	fullStatement: string
+	alternativeLabel?: string
+	CFItemType?: string
+	cfItemType?: string
+	humanCodingScheme?: string
+	listEnumeration?: string
+	abbreviatedStatement?: string
+	conceptKeywords?: string[]
+	notes?: string
+	subject?: string[]
+	language?: string
+	educationLevel?: string[]
+	CFItemTypeURI?: unknown
+	licenseURI?: unknown
+	statusStartDate?: string
+	statusEndDate?: string
+	extensions?: unknown
+}
+
+/**
+ * Association definition within a package upload.
+ */
+interface CFAssociationInput {
+	identifier: string
+	uri: string
+	lastChangeDateTime: string
+	associationType: string
+	originNodeURI: InputNodeURI
+	destinationNodeURI: InputNodeURI
+	sequenceNumber?: number
+	extensions?: unknown
+}
+
+/**
+ * Optional definitions section within a package upload.
+ */
+interface CFDefinitions {
+	CFItemTypes?: unknown[]
+	CFSubjects?: unknown[]
+	CFConcepts?: unknown[]
+	CFLicenses?: unknown[]
+	CFAssociationGroupings?: unknown[]
+	extensions?: unknown
+}
+
+/**
+ * Input payload for creating or replacing a CASE package.
+ */
+interface CFPackageInput {
+	CFDocument: CFDocumentInput
+	CFItems: CFItemInput[]
+	CFAssociations: CFAssociationInput[]
+	CFDefinitions?: CFDefinitions
+	extensions?: unknown
+}
+
+/**
+ * Result returned after uploading or replacing a CASE package.
+ */
+interface CFPackageUploadResult {
+	success: boolean
+	message: string
+	result: {
+		documentId: string
+		stats: {
+			documents: number
+			items: number
+			associations: number
+		}
+		success: boolean
+	}
+}
+
+/**
+ * Transport interface for CASE client.
+ */
+interface CaseTransportLike {
+    /** Base URL of the API */
+    baseUrl: string;
+    /** API path profiles for CASE operations */
+    paths: CasePaths;
+    /** Make an authenticated request */
+    request<T>(path: string, options?: RequestOptions): Promise<T>;
+    /** Make a paginated request */
+    requestPaginated<T>(path: string, options?: RequestOptions): Promise<PaginatedResponse<T>>;
+}
+/**
+ * All supported CASE client configuration types.
+ */
+type CaseClientConfig = ClientConfig | TransportOnlyConfig<CaseTransportLike> | ProviderClientConfig;
+/**
+ * Configuration for CASE transport.
+ */
+interface CaseTransportConfig extends TransportConfigWithTokenProvider {
+    /** API path profiles for CASE operations */
+    paths: CasePaths;
+}
+/**
+ * Instance type of CaseClient.
+ */
+type CaseClientInstance = InstanceType<typeof CaseClient>;
+
+/**
+ * CFAssociations Resource
+ *
+ * CASE Framework Associations — relationships between CASE entities.
+ */
+
+/** CASE Framework Associations resource. */
+declare class AssociationsResource {
+    private readonly transport;
+    constructor(transport: CaseTransportLike);
+    /**
+     * Get a CASE association by sourcedId.
+     *
+     * @param sourcedId - The association's sourcedId
+     * @returns The CFAssociation
+     */
+    get(sourcedId: string): Promise<{
+        CFAssociation: CFAssociation;
+    }>;
+}
+
+/**
+ * CFDocuments Resource
+ *
+ * CASE Framework Documents — curriculum frameworks and standards documents.
+ */
+
+/** CASE Framework Documents resource. */
+declare class DocumentsResource {
+    private readonly transport;
+    constructor(transport: CaseTransportLike);
+    /**
+     * List all CASE documents.
+     *
+     * @param params - Optional query parameters (offset, limit, filter, sort, orderBy)
+     * @returns Wrapped response containing CFDocuments array
+     */
+    list(params?: Record<string, string | number>): Promise<{
+        CFDocuments: CFDocument[];
+    }>;
+    /**
+     * Get a CASE document by sourcedId.
+     *
+     * @param sourcedId - The document's sourcedId
+     * @returns The CFDocument
+     */
+    get(sourcedId: string): Promise<{
+        CFDocument: CFDocument;
+    }>;
+}
+
+/**
+ * CFItems Resource
+ *
+ * CASE Framework Items — individual competencies, standards, and learning objectives.
+ */
+
+/** CASE Framework Items resource. */
+declare class ItemsResource {
+    private readonly transport;
+    constructor(transport: CaseTransportLike);
+    /**
+     * List all CASE items.
+     *
+     * @param params - Optional query parameters (offset, limit, filter, sort, orderBy)
+     * @returns Wrapped response containing CFItems array
+     */
+    list(params?: Record<string, string | number>): Promise<{
+        CFItems: CFItem[];
+    }>;
+    /**
+     * Get a CASE item by sourcedId.
+     *
+     * @param sourcedId - The item's sourcedId
+     * @returns The CFItem
+     */
+    get(sourcedId: string): Promise<{
+        CFItem: CFItem;
+    }>;
+}
+
+/**
+ * CFPackages Resource
+ *
+ * CASE Framework Packages — complete bundles of documents, items, and associations.
+ */
+
+/** CASE Framework Packages resource. */
+declare class PackagesResource {
+    private readonly transport;
+    constructor(transport: CaseTransportLike);
+    /**
+     * Upload a complete CASE package.
+     *
+     * @param input - The package to upload (document, items, and associations)
+     * @returns Upload result with document ID and stats
+     */
+    create(input: CFPackageInput): Promise<CFPackageUploadResult>;
+    /**
+     * Replace a CASE package by sourcedId.
+     *
+     * @param sourcedId - The package's document sourcedId
+     * @param input - The replacement package
+     * @returns Upload result with document ID and stats
+     */
+    update(sourcedId: string, input: CFPackageInput): Promise<CFPackageUploadResult>;
+    /**
+     * Get a CASE package by sourcedId.
+     *
+     * @param sourcedId - The package's document sourcedId
+     * @returns The complete CFPackage
+     */
+    get(sourcedId: string): Promise<{
+        CFPackage: CFPackage;
+    }>;
+    /**
+     * Get a CASE package with hierarchical group structure.
+     *
+     * @param sourcedId - The package's document sourcedId
+     * @returns The package with items organized into groups
+     */
+    getGroups(sourcedId: string): Promise<{
+        CFPackageWithGroups: CFPackageWithGroups;
+    }>;
+}
+
+/**
+ * CASE Client
+ *
+ * Main entry point for the CASE SDK.
+ */
+/**
+ * CASE API client for Competency and Academic Standards Exchange.
+ *
+ * Provides access to CASE endpoints including documents, items,
+ * associations, and package management.
+ *
+ * @example
+ * ```typescript
+ * const client = new CaseClient({
+ *   env: 'staging',
+ *   auth: {
+ *     clientId: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *   },
+ * })
+ *
+ * // List all framework documents
+ * const docs = await client.documents.list()
+ *
+ * // Get a specific package
+ * const pkg = await client.packages.get(sourcedId)
+ * ```
+ */
+declare const CaseClient: {
+    new (config?: CaseClientConfig): {
+        readonly transport: CaseTransportLike;
+        readonly _provider?: _timeback_internal_client_infra.TimebackProvider | undefined;
+        readonly documents: DocumentsResource;
+        readonly items: ItemsResource;
+        readonly associations: AssociationsResource;
+        readonly packages: PackagesResource;
+        getTransport(): CaseTransportLike;
+        checkAuth(): Promise<_timeback_internal_client_infra.AuthCheckResult>;
+    };
+};
+
+/**
+ * CASE Client Factory
+ *
+ * Creates CaseClient classes bound to specific provider registries.
+ */
+
+/**
+ * Create a CaseClient class bound to a specific provider registry.
+ *
+ * @param registry - Provider registry to use (defaults to all Timeback platforms)
+ * @returns CaseClient class bound to the registry
+ */
+declare function createCaseClient(registry?: ProviderRegistry): {
+    new (config?: CaseClientConfig): {
+        /** @internal */
+        readonly transport: CaseTransportLike;
+        /** @internal */
+        readonly _provider?: TimebackProvider | undefined;
+        /** Query CASE framework documents */
+        readonly documents: DocumentsResource;
+        /** Query CASE framework items (competencies, standards) */
+        readonly items: ItemsResource;
+        /** Query CASE framework associations */
+        readonly associations: AssociationsResource;
+        /** Upload, replace, and retrieve CASE framework packages */
+        readonly packages: PackagesResource;
+        /**
+         * Get the underlying transport for advanced use cases.
+         * @returns The transport instance used by this client
+         */
+        getTransport(): CaseTransportLike;
+        /**
+         * Verify that OAuth authentication is working.
+         * @returns Auth check result
+         * @throws {Error} If client was initialized with custom transport (no provider)
+         */
+        checkAuth(): Promise<AuthCheckResult>;
+    };
+};
+
+/**
+ * Transport Layer
+ *
+ * HTTP transport for CASE API communication.
+ */
+
+/**
+ * HTTP transport layer for CASE API communication.
+ *
+ * Uses header-based pagination (same as OneRoster) for list endpoints.
+ */
+declare class Transport extends BaseTransport {
+    readonly paths: CasePaths;
+    constructor(config: CaseTransportConfig);
+    /**
+     * Make a paginated request using header-based pagination.
+     *
+     * @template T - Expected item type in the response array
+     * @param path - API endpoint path
+     * @param options - Request options
+     * @returns Response data with hasMore flag and optional total count
+     */
+    requestPaginated<T>(path: string, options?: RequestOptions): Promise<PaginatedResponse<T>>;
+}
+
+export { CaseClient, Transport, createCaseClient };
+export type { CFAssociation, CFAssociationInput, CFDefinitions, CFDocument, CFDocumentInput, CFItem, CFItemInput, CFItemWithChildGroups, CFPackage, CFPackageInput, CFPackageUploadResult, CFPackageWithGroups, CaseClientConfig, CaseClientInstance, InputNodeURI, LinkURI, OptionalLinkURI };

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAMH,OAAO,EAAE,UAAU,EAAE,KAAK,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAE5C,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAMtD,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAExE,YAAY,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAEtE,YAAY,EACX,aAAa,EACb,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,eAAe,EACf,MAAM,EACN,WAAW,EACX,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,YAAY,EACZ,OAAO,EACP,eAAe,GACf,MAAM,gCAAgC,CAAA;AAMvC,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA"}