@forumulate/sdk 0.11.3 → 0.11.4

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/CHANGELOG.md CHANGED
@@ -3,6 +3,17 @@
3
3
  Releases of `@forumulate/sdk`. Earlier versions are described in the git history of
4
4
  `packages/sdk` (`release(sdk): …` commits).
5
5
 
6
+ ## 0.11.4
7
+
8
+ ### Added
9
+ - Types and operations for export jobs (`GET /orgs/{orgId}/exports/{id}` and its
10
+ `/download`), `?nav=lean|lean-all|lean-listing` on the public space and site
11
+ overviews, and `GET /public/orgs/{org}/spaces/{space}/nav/{nodeId}/children`.
12
+
13
+ ### Changed
14
+ - A CSV export past 20,000 rows answers `202` with the job; `exportCsv()` returns
15
+ that job (follow `links.result` once it completes) instead of the CSV text.
16
+
6
17
  ## 0.11.0
7
18
 
8
19
  Every settings object writable by PATCH, site-level settings, a whole site from one manifest, and stable method names.
package/dist/http.d.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  * and not another.
7
7
  */
8
8
  /** Kept in step with package.json by `coverage.test.ts`. */
9
- export declare const SDK_VERSION = "0.11.3";
9
+ export declare const SDK_VERSION = "0.11.4";
10
10
  /** The API's error envelope: `{ error: { code, message, details? }, requestId? }`. */
11
11
  export interface ForumulateErrorInit {
12
12
  /** Field-level detail, e.g. `{ title: ['Required'] }` for `validation.failed`. */
package/dist/http.js CHANGED
@@ -11,7 +11,7 @@ exports.ForumulateError = exports.SDK_VERSION = void 0;
11
11
  exports.retryDelayMs = retryDelayMs;
12
12
  exports.send = send;
13
13
  /** Kept in step with package.json by `coverage.test.ts`. */
14
- exports.SDK_VERSION = '0.11.3';
14
+ exports.SDK_VERSION = '0.11.4';
15
15
  /**
16
16
  * Thrown for any non-2xx API response, and for a network failure that
17
17
  * outlived its retries (`status: 0`, `code: 'network.error'`). Mirrors the
@@ -1088,7 +1088,7 @@ export declare const OPERATIONS: {
1088
1088
  readonly patchInstructors: "PATCH ~s/course/instructors";
1089
1089
  readonly payout: "POST ~s/course/payouts";
1090
1090
  readonly rev: "GET ~s/course/revenue";
1091
- readonly csv: "GET ~s/course/revenue/export.csv";
1091
+ readonly exportCsv: "GET ~s/course/revenue/export.csv";
1092
1092
  readonly delete: "=remove DELETE ~s/course/offers/{offerId}";
1093
1093
  }];
1094
1094
  readonly CoursePackageFiles: readonly ["courses.packageFiles", {
@@ -1645,6 +1645,10 @@ export declare const OPERATIONS: {
1645
1645
  readonly exportJson: "GET /privacy/executor/{orgId}/v2/requests/{id}/export";
1646
1646
  readonly exportZip: "GET /privacy/executor/{orgId}/v2/requests/{id}/export.zip b";
1647
1647
  }];
1648
+ readonly Exports: readonly ["exports", {
1649
+ readonly get: "GET ~o/exports/{exportId}";
1650
+ readonly download: "GET ~o/exports/{exportId}/download t";
1651
+ }];
1648
1652
  readonly Extension: readonly ["extensions", {
1649
1653
  readonly list: "GET ~o/extensions p";
1650
1654
  readonly available: "GET ~o/extensions/available p";
@@ -2984,18 +2988,18 @@ export declare const OPERATIONS: {
2984
2988
  readonly seo: "GET ~P/seo";
2985
2989
  readonly siteOf: "GET ~P/site";
2986
2990
  readonly chrome: "GET ~P/chrome";
2987
- readonly sitemap: "GET ~P/sitemap.xml";
2988
- readonly robots: "GET ~P/robots.txt";
2989
2991
  readonly updates: "GET ~P/updates p";
2990
- readonly llmsTxt: "GET ~P/llms.txt";
2991
- readonly llmsFull: "GET ~P/llms-full.txt";
2992
- readonly skillMd: "GET ~P/skill.md";
2993
2992
  readonly pageMarkdown: "GET ~P/pages/{pageId}.md";
2994
2993
  readonly overview: "GET ~P";
2995
2994
  readonly pageVersion: "GET ~P/pages/{pageId}/version";
2996
2995
  readonly page: "GET ~P/pages/{pageId}";
2997
2996
  readonly exportAll: "GET ~P/export";
2998
2997
  readonly view: "POST ~P/pages/{pageId}/view";
2998
+ readonly sitemap: "GET ~P/sitemap.xml";
2999
+ readonly robots: "GET ~P/robots.txt";
3000
+ readonly llmsTxt: "GET ~P/llms.txt";
3001
+ readonly llmsFull: "GET ~P/llms-full.txt";
3002
+ readonly skillMd: "GET ~P/skill.md";
2999
3003
  }];
3000
3004
  readonly PublicAbout: readonly ["public.about", {
3001
3005
  readonly view: "GET ~P/about";
@@ -3065,6 +3069,9 @@ export declare const OPERATIONS: {
3065
3069
  readonly sfuRole: "POST ~P/live-rooms/{roomId}/sfu-role";
3066
3070
  readonly sfuEnd: "POST ~P/live-rooms/{roomId}/sfu-end";
3067
3071
  }];
3072
+ readonly PublicNav: readonly ["public.nav", {
3073
+ readonly children: "GET ~P/nav/{nodeId}/children";
3074
+ }];
3068
3075
  readonly PublicNetwork: readonly ["public.network", {
3069
3076
  readonly check: "GET ~P/network-check";
3070
3077
  readonly facts: "GET ~P/network-check/facts";
@@ -151,7 +151,7 @@ exports.OPERATIONS = {
151
151
  CourseLessonKinds: ['courses.lessonKinds', { requirement: 'GET ~s/course/lessons/{slug}/requirement', watch: 'POST ~s/course/lessons/{slug}/watch', mine: 'GET ~s/course/lessons/{slug}/assignment', submit: 'POST ~s/course/lessons/{slug}/assignment', upload: 'POST ~s/course/lessons/{slug}/assignment-files m', quizFile: 'POST ~s/course/quizzes/{quizId}/files m', queue: 'GET ~s/course/assignments p', grade: 'PATCH ~s/course/assignments/{id}' }],
152
152
  MyLearning: ['courses.myLearning', { mine: 'GET ~o/me/courses p' }],
153
153
  MyCoursePaths: ['courses.myPaths', { mine: 'GET ~o/me/course-paths p' }],
154
- CourseOffers: ['courses.offers', { list: 'GET ~s/course/offers p', create: 'POST ~s/course/offers', update: 'PUT ~s/course/offers/{offerId}', remove: 'DELETE ~s/course/offers/{offerId}', bulk: 'POST ~s/course/coupons/bulk', earnings: 'GET ~s/course/earnings', instructors: 'PUT ~s/course/instructors', patchInstructors: 'PATCH ~s/course/instructors', payout: 'POST ~s/course/payouts', rev: 'GET ~s/course/revenue', csv: 'GET ~s/course/revenue/export.csv', delete: '=remove DELETE ~s/course/offers/{offerId}' }],
154
+ CourseOffers: ['courses.offers', { list: 'GET ~s/course/offers p', create: 'POST ~s/course/offers', update: 'PUT ~s/course/offers/{offerId}', remove: 'DELETE ~s/course/offers/{offerId}', bulk: 'POST ~s/course/coupons/bulk', earnings: 'GET ~s/course/earnings', instructors: 'PUT ~s/course/instructors', patchInstructors: 'PATCH ~s/course/instructors', payout: 'POST ~s/course/payouts', rev: 'GET ~s/course/revenue', exportCsv: 'GET ~s/course/revenue/export.csv', delete: '=remove DELETE ~s/course/offers/{offerId}' }],
155
155
  CoursePackageFiles: ['courses.packageFiles', { file: 'GET /course-packages/{id}/{token}/{p0} b', fileDepth2: 'GET /course-packages/{id}/{token}/{p0}/{p1} b', fileDepth3: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2} b', fileDepth4: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3} b', fileDepth5: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4} b', fileDepth6: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5} b', fileDepth7: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6} b', fileDepth8: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6}/{p7} b', fileDepth9: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6}/{p7}/{p8} b', fileDepth10: 'GET /course-packages/{id}/{token}/{p0}/{p1}/{p2}/{p3}/{p4}/{p5}/{p6}/{p7}/{p8}/{p9} b', putStatements: 'PUT /course-xapi/{id}/{token}/statements', statements: 'POST /course-xapi/{id}/{token}/statements', fetch: 'POST /course-xapi/{id}/{token}/fetch', launchData: 'GET /course-xapi/{id}/{token}/activities/state', saveState: 'PUT /course-xapi/{id}/{token}/activities/state' }],
156
156
  CoursePackages: ['courses.packages', { upload: 'POST ~s/course/lessons/{slug}/package m', launch: 'GET ~s/course/lessons/{slug}/package', commit: 'POST ~s/course/packages/{packageId}/state' }],
157
157
  CoursePaths: ['courses.paths', { list: 'GET ~o/course-paths p', create: 'POST ~o/course-paths', replace: 'PUT ~o/course-paths/{pathId}', remove: 'DELETE ~o/course-paths/{pathId}', delete: '=remove DELETE ~o/course-paths/{pathId}' }],
@@ -228,6 +228,7 @@ exports.OPERATIONS = {
228
228
  EventTicketWebhook: ['events.ticketWebhook', { webhook: 'POST /public/payments/stripe/{orgId}/webhook' }],
229
229
  ExecutorAdmin: ['executorAdmin', { state: 'GET ~o/privacy/executor', update: 'PUT ~o/privacy/executor', patch: 'PATCH ~o/privacy/executor', test: 'POST ~o/privacy/executor-key/test' }],
230
230
  ExecutorV2: ['executorV2', { lookup: 'POST /privacy/executor/{orgId}/v2/lookup', open: 'POST /privacy/executor/{orgId}/v2/requests', list: 'GET /privacy/executor/{orgId}/v2/requests p', get: 'GET /privacy/executor/{orgId}/v2/requests/{id}', cancel: 'POST /privacy/executor/{orgId}/v2/requests/{id}/cancel', exportJson: 'GET /privacy/executor/{orgId}/v2/requests/{id}/export', exportZip: 'GET /privacy/executor/{orgId}/v2/requests/{id}/export.zip b' }],
231
+ Exports: ['exports', { get: 'GET ~o/exports/{exportId}', download: 'GET ~o/exports/{exportId}/download t' }],
231
232
  Extension: ['extensions', { list: 'GET ~o/extensions p', available: 'GET ~o/extensions/available p', install: 'POST ~o/extensions/install', update: 'PATCH ~o/extensions/{id}', uninstall: 'DELETE ~o/extensions/{id}', test: 'POST ~o/extensions/{id}/test', deliveries: 'GET ~o/extensions/{id}/deliveries p', rotate: 'POST ~o/extensions/{id}/rotate', upgrade: 'POST ~o/extensions/{id}/upgrade' }],
232
233
  ExtApi: ['extensions.api', { me: 'GET /ext/v1/me', page: 'GET /ext/v1/pages/{pageId}', spacePages: 'GET /ext/v1/spaces/{spaceId}/pages p', saveDraft: 'POST /ext/v1/pages/{pageId}/draft', comments: 'GET /ext/v1/pages/{pageId}/comments p', postComment: 'POST /ext/v1/pages/{pageId}/comments', members: 'GET /ext/v1/members p', analytics: 'GET /ext/v1/spaces/{spaceId}/analytics' }],
233
234
  PublicRegistry: ['extensions.publicRegistry', { list: 'GET /registry/extensions p', get: 'GET /registry/extensions/{slug}' }],
@@ -413,7 +414,7 @@ exports.OPERATIONS = {
413
414
  CookieMunchLink: ['privacy.cookieMunchLink', { status: 'GET ~o/privacy/cookiemunch', connect: 'POST ~o/privacy/cookiemunch/connect' }],
414
415
  PrivacyExecutor: ['privacy.executor', { exportPolicyAcceptances: 'POST /privacy/executor/{orgId}/policy-acceptances/export', erasePolicyAcceptances: 'POST /privacy/executor/{orgId}/policy-acceptances/erase', lookup: 'POST /privacy/executor/{orgId}/lookup', open: 'POST /privacy/executor/{orgId}/requests', list: 'GET /privacy/executor/{orgId}/requests p', status: 'GET /privacy/executor/{orgId}/requests/{id}', cancel: 'POST /privacy/executor/{orgId}/requests/{id}/cancel', export: 'GET /privacy/executor/{orgId}/requests/{id}/export' }],
415
416
  ConsentPublic: ['privacy.publicConsent', { resolved: 'GET ~P/consent', record: 'POST ~P/consent/receipts' }],
416
- Public: ['public', { gate: 'GET ~P/gate', hubIntro: 'GET ~P/hubs/{kind}/{key}', search: 'GET ~P/search', pdf: 'GET ~P/pdf b', pagePdf: 'GET ~P/pages/{pageId}/pdf b', faq: 'GET ~P/faq', apiOrigins: 'GET ~P/api-origins p', scriptOrigins: 'GET ~P/script-origins p', styleOrigins: 'GET ~P/style-origins', seo: 'GET ~P/seo', siteOf: 'GET ~P/site', chrome: 'GET ~P/chrome', sitemap: 'GET ~P/sitemap.xml', robots: 'GET ~P/robots.txt', updates: 'GET ~P/updates p', llmsTxt: 'GET ~P/llms.txt', llmsFull: 'GET ~P/llms-full.txt', skillMd: 'GET ~P/skill.md', pageMarkdown: 'GET ~P/pages/{pageId}.md', overview: 'GET ~P', pageVersion: 'GET ~P/pages/{pageId}/version', page: 'GET ~P/pages/{pageId}', exportAll: 'GET ~P/export', view: 'POST ~P/pages/{pageId}/view' }],
417
+ Public: ['public', { gate: 'GET ~P/gate', hubIntro: 'GET ~P/hubs/{kind}/{key}', search: 'GET ~P/search', pdf: 'GET ~P/pdf b', pagePdf: 'GET ~P/pages/{pageId}/pdf b', faq: 'GET ~P/faq', apiOrigins: 'GET ~P/api-origins p', scriptOrigins: 'GET ~P/script-origins p', styleOrigins: 'GET ~P/style-origins', seo: 'GET ~P/seo', siteOf: 'GET ~P/site', chrome: 'GET ~P/chrome', updates: 'GET ~P/updates p', pageMarkdown: 'GET ~P/pages/{pageId}.md', overview: 'GET ~P', pageVersion: 'GET ~P/pages/{pageId}/version', page: 'GET ~P/pages/{pageId}', exportAll: 'GET ~P/export', view: 'POST ~P/pages/{pageId}/view', sitemap: 'GET ~P/sitemap.xml', robots: 'GET ~P/robots.txt', llmsTxt: 'GET ~P/llms.txt', llmsFull: 'GET ~P/llms-full.txt', skillMd: 'GET ~P/skill.md' }],
417
418
  PublicAbout: ['public.about', { view: 'GET ~P/about', search: 'GET ~P/about/search p' }],
418
419
  PublicAddressIndex: ['public.addressIndex', { addressIndex: 'GET ~P/address-index', root: 'GET ~P/root' }],
419
420
  PublicCaptcha: ['public.captcha', { get: 'GET /public/orgs/{orgId}/captcha' }],
@@ -425,6 +426,7 @@ exports.OPERATIONS = {
425
426
  IntegratorPublic: ['public.integrator', { cookieManifest: 'GET /public/orgs/{orgId}/cookie-manifest', embedManifest: 'GET /public/embed', report: 'POST /public/csp-reports/{orgId}' }],
426
427
  PublicInteraction: ['public.interaction', { ask: 'POST ~P/ask', askStream: 'POST ~P/ask/stream b', askFeedback: 'POST ~P/ask/{queryId}/feedback', listComments: 'GET ~P/pages/{pageId}/comments p', postComment: 'POST ~P/pages/{pageId}/comments', reactToComment: 'POST ~P/comments/{commentId}/react', extRender: 'POST ~P/ext/render', extAction: 'POST ~P/ext/action', feedback: 'POST ~P/pages/{pageId}/feedback', faqSearchEvent: 'POST ~P/faq/search-events', searchEvent: 'POST ~P/search-events' }],
427
428
  LiveRoomsPublic: ['public.liveRooms', { list: 'GET ~P/live-rooms', one: 'GET ~P/live-rooms/{roomId}', join: 'POST ~P/live-rooms/{roomId}/join', stream: 'GET ~P/live-rooms/{roomId}/stream b', signal: 'POST ~P/live-rooms/{roomId}/signal', heartbeat: 'POST ~P/live-rooms/{roomId}/heartbeat', leave: 'POST ~P/live-rooms/{roomId}/leave', role: 'POST ~P/live-rooms/{roomId}/role', end: 'POST ~P/live-rooms/{roomId}/end', sfuRole: 'POST ~P/live-rooms/{roomId}/sfu-role', sfuEnd: 'POST ~P/live-rooms/{roomId}/sfu-end' }],
429
+ PublicNav: ['public.nav', { children: 'GET ~P/nav/{nodeId}/children' }],
428
430
  PublicNetwork: ['public.network', { check: 'GET ~P/network-check', facts: 'GET ~P/network-check/facts' }],
429
431
  PublicNewsroom: ['public.newsroom', { resolve: 'POST /public/orgs/{orgId}/newsroom/resolve', remind: 'POST ~P/blog/{topicId}/remind' }],
430
432
  PublicOembed: ['public.oembed', { oembed: 'GET ~P/oembed' }],
package/dist/schema.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  [diffend] Oversized file quarantined before diffing.
2
2
  name: package/dist/schema.d.ts
3
- size: 34782328 bytes
4
- sha256: f987074d98809f4a6497e2aa36a9618cc54bff81e1c258b25fc7898f87e76754
3
+ size: 34806671 bytes
4
+ sha256: ad8b4b08ed789898d232c8f742e55563b02a6789bdb25a43eb9e65987488709d
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forumulate/sdk",
3
- "version": "0.11.3",
3
+ "version": "0.11.4",
4
4
  "description": "Typed TypeScript client for the Forumulate REST API.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://forumulate.com/reference",