@timeback/powerpath 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +138 -0
- package/dist/client.d.ts +70 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/constants.d.ts +25 -0
- package/dist/constants.d.ts.map +1 -0
- package/dist/errors.d.ts +9 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +1480 -0
- package/dist/factory.d.ts +46 -0
- package/dist/factory.d.ts.map +1 -0
- package/dist/index.d.ts +40 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +16775 -0
- package/dist/lib/index.d.ts +10 -0
- package/dist/lib/index.d.ts.map +1 -0
- package/dist/lib/pagination.d.ts +20 -0
- package/dist/lib/pagination.d.ts.map +1 -0
- package/dist/lib/resolve.d.ts +21 -0
- package/dist/lib/resolve.d.ts.map +1 -0
- package/dist/lib/transport.d.ts +36 -0
- package/dist/lib/transport.d.ts.map +1 -0
- package/dist/resources/assessment.d.ts +29 -0
- package/dist/resources/assessment.d.ts.map +1 -0
- package/dist/resources/index.d.ts +7 -0
- package/dist/resources/index.d.ts.map +1 -0
- package/dist/resources/lesson-plans.d.ts +28 -0
- package/dist/resources/lesson-plans.d.ts.map +1 -0
- package/dist/resources/placement.d.ts +22 -0
- package/dist/resources/placement.d.ts.map +1 -0
- package/dist/resources/screening.d.ts +20 -0
- package/dist/resources/screening.d.ts.map +1 -0
- package/dist/resources/syllabus.d.ts +17 -0
- package/dist/resources/syllabus.d.ts.map +1 -0
- package/dist/resources/test-assignments.d.ts +63 -0
- package/dist/resources/test-assignments.d.ts.map +1 -0
- package/dist/types/client.d.ts +54 -0
- package/dist/types/client.d.ts.map +1 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types.d.ts +10 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +0 -0
- package/dist/utils.d.ts +11 -0
- package/dist/utils.d.ts.map +1 -0
- package/package.json +45 -0
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PowerPath Client Factory
|
|
3
|
+
*
|
|
4
|
+
* Creates PowerPathClient classes bound to specific provider registries.
|
|
5
|
+
*/
|
|
6
|
+
import { AssessmentResource, LessonPlansResource, PlacementResource, ScreeningResource, SyllabusResource, TestAssignmentsResource } from './resources';
|
|
7
|
+
import type { AuthCheckResult, ProviderRegistry, TimebackProvider } from '@timeback/internal-client-infra';
|
|
8
|
+
import type { PowerPathClientConfig, PowerPathTransportLike } from './types';
|
|
9
|
+
/**
|
|
10
|
+
* Create a PowerPathClient class bound to a specific provider registry.
|
|
11
|
+
*
|
|
12
|
+
* @param registry - Provider registry to use (defaults to all Timeback platforms)
|
|
13
|
+
* @returns PowerPathClient class bound to the registry
|
|
14
|
+
*/
|
|
15
|
+
export declare function createPowerPathClient(registry?: ProviderRegistry): {
|
|
16
|
+
new (config?: PowerPathClientConfig): {
|
|
17
|
+
/** @internal */
|
|
18
|
+
readonly transport: PowerPathTransportLike;
|
|
19
|
+
/** @internal */
|
|
20
|
+
readonly _provider?: TimebackProvider | undefined;
|
|
21
|
+
/** Create tests, attempts, and assessment responses */
|
|
22
|
+
readonly assessments: AssessmentResource;
|
|
23
|
+
/** Manage lesson plans and course progress */
|
|
24
|
+
readonly lessonPlans: LessonPlansResource;
|
|
25
|
+
/** Placement testing and progress */
|
|
26
|
+
readonly placement: PlacementResource;
|
|
27
|
+
/** Screening sessions and results */
|
|
28
|
+
readonly screening: ScreeningResource;
|
|
29
|
+
/** Course syllabus retrieval */
|
|
30
|
+
readonly syllabus: SyllabusResource;
|
|
31
|
+
/** Test assignment CRUD and bulk operations */
|
|
32
|
+
readonly testAssignments: TestAssignmentsResource;
|
|
33
|
+
/**
|
|
34
|
+
* Get the underlying transport for advanced use cases.
|
|
35
|
+
* @returns The transport instance used by this client
|
|
36
|
+
*/
|
|
37
|
+
getTransport(): PowerPathTransportLike;
|
|
38
|
+
/**
|
|
39
|
+
* Verify that OAuth authentication is working.
|
|
40
|
+
* @returns Auth check result
|
|
41
|
+
* @throws {Error} If client was initialized with custom transport (no provider)
|
|
42
|
+
*/
|
|
43
|
+
checkAuth(): Promise<AuthCheckResult>;
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
//# sourceMappingURL=factory.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,EACN,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,uBAAuB,EACvB,MAAM,aAAa,CAAA;AAGpB,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAC1G,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAE5E;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,GAAE,gBAA4C;;QAQ1F,gBAAgB;;QAGhB,gBAAgB;;QAGhB,uDAAuD;;QAEvD,8CAA8C;;QAE9C,qCAAqC;;QAErC,qCAAqC;;QAErC,gCAAgC;;QAEhC,+CAA+C;;QA8C/C;;;WAGG;;QAKH;;;;WAIG;;;EASJ"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PowerPath API client SDK for Timeback.
|
|
3
|
+
*
|
|
4
|
+
* @example Environment mode (Timeback APIs)
|
|
5
|
+
* ```typescript
|
|
6
|
+
* import { PowerPathClient } from '@timeback/powerpath'
|
|
7
|
+
*
|
|
8
|
+
* const client = new PowerPathClient({
|
|
9
|
+
* env: 'staging',
|
|
10
|
+
* auth: {
|
|
11
|
+
* clientId: 'your-client-id',
|
|
12
|
+
* clientSecret: 'your-client-secret',
|
|
13
|
+
* },
|
|
14
|
+
* })
|
|
15
|
+
*
|
|
16
|
+
* // Create an internal test
|
|
17
|
+
* await client.assessments.createInternalTest({ ... })
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* @example Explicit mode (custom API)
|
|
21
|
+
* ```typescript
|
|
22
|
+
* const client = new PowerPathClient({
|
|
23
|
+
* baseUrl: 'https://api.example.com',
|
|
24
|
+
* auth: {
|
|
25
|
+
* clientId: 'your-client-id',
|
|
26
|
+
* clientSecret: 'your-client-secret',
|
|
27
|
+
* authUrl: 'https://auth.example.com/oauth2/token',
|
|
28
|
+
* },
|
|
29
|
+
* })
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export { PowerPathClient, type PowerPathClientInstance } from './client';
|
|
33
|
+
export { createPowerPathClient } from './factory';
|
|
34
|
+
export type { PowerPathClientConfig } from './types/client';
|
|
35
|
+
export type { Environment, EnvAuth, ExplicitAuth } from './types/client';
|
|
36
|
+
export type { AuthCheckResult, ListParams, PageResult } from '@timeback/internal-client-infra';
|
|
37
|
+
export type { AssignmentResult, BulkResult, TestAssignment, TestAssignmentStatus, TestAssignmentsListResponse, Attempt, CreateAttemptResponse, ExternalTestCreateResponse, GetAssessmentProgressResponse, GetAttemptsResponse, ResetAttemptResponse, GetAllPlacementTestsResponse, GetCurrentLevelResponse, GetNextPlacementTestResponse, GetSubjectProgressResponse, ResetPlacementResponse, ScreeningAssignTestResponse, ScreeningResetSessionResponse, ScreeningResultsResponse, ScreeningSessionResponse, CourseProgressResponse, LessonPlanCourseSyncResult, LessonPlanCreateResponse, LessonPlanOperation, LessonPlanOperationResult, LessonPlanOperationsResponse, LessonPlanResponse, LessonPlanSyncResult, UpdateStudentItemResponseResult, SyllabusResponse, PaginationMeta, } from '@timeback/types/protocols/powerpath';
|
|
38
|
+
export type { CreateExternalPlacementTestInput, CreateExternalTestOutInput, CreateInternalTestInput, CreateNewAttemptInput, FinalStudentAssessmentResponseInput, GetAssessmentProgressParams, GetAttemptsParams, GetNextQuestionParams, ImportExternalTestAssignmentResultsParams, LessonPlanOperationInput, LessonPlanOperationsInput, LessonPlansCreateInput, LessonPlanUpdateStudentItemResponseInput, MakeExternalTestAssignmentInput, PlacementQueryParams, PlacementResetUserPlacementInput, ResetAttemptInput, ScreeningAssignTestInput, ScreeningResetSessionInput, SyllabusQueryParams, TestAssignmentsAdminParams, TestAssignmentsBulkInput, TestAssignmentsCreateInput, TestAssignmentsImportInput, TestAssignmentsListParams, TestAssignmentsUpdateInput, TestOutParams, UpdateStudentQuestionResponseInput, } from '@timeback/types/zod';
|
|
39
|
+
export { Paginator, Transport } from './lib';
|
|
40
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAMH,OAAO,EAAE,eAAe,EAAE,KAAK,uBAAuB,EAAE,MAAM,UAAU,CAAA;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAEjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAM3D,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAExE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAE9F,YAAY,EAEX,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,2BAA2B,EAE3B,OAAO,EACP,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,mBAAmB,EACnB,oBAAoB,EAEpB,4BAA4B,EAC5B,uBAAuB,EACvB,4BAA4B,EAC5B,0BAA0B,EAC1B,sBAAsB,EAEtB,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,wBAAwB,EAExB,sBAAsB,EACtB,0BAA0B,EAC1B,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,4BAA4B,EAC5B,kBAAkB,EAClB,oBAAoB,EACpB,+BAA+B,EAE/B,gBAAgB,EAEhB,cAAc,GACd,MAAM,qCAAqC,CAAA;AAM5C,YAAY,EACX,gCAAgC,EAChC,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,mCAAmC,EACnC,2BAA2B,EAC3B,iBAAiB,EACjB,qBAAqB,EACrB,yCAAyC,EACzC,wBAAwB,EACxB,yBAAyB,EACzB,sBAAsB,EACtB,wCAAwC,EACxC,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EAChC,iBAAiB,EACjB,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,EACzB,0BAA0B,EAC1B,aAAa,EACb,kCAAkC,GAClC,MAAM,qBAAqB,CAAA;AAM5B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA"}
|