@forumulate/sdk 0.1.0 → 0.2.0

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.
Files changed (9) hide show
  1. package/dist/index.d.ts +26 -2
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/index.js +50 -10
  4. package/dist/index.js.map +1 -1
  5. package/dist/schema.d.ts +27349 -13907
  6. package/dist/schema.d.ts.map +1 -1
  7. package/dist/typed.d.ts +12 -1
  8. package/dist/typed.d.ts.map +1 -1
  9. package/package.json +1 -1
package/dist/typed.d.ts CHANGED
@@ -99,10 +99,21 @@ type Simplify<T> = {
99
99
  /**
100
100
  * The `init` argument for `typed(method, path, init)`, derived from the route:
101
101
  * path params, query params and JSON body are each required exactly when the
102
- * spec says so, plus a `raw` escape to get the untouched `Response` back.
102
+ * spec says so, plus a `raw` escape to get the untouched `Response` back and
103
+ * `headers` for the two the API expects per call.
104
+ *
105
+ * `headers` is deliberately a free `Record` rather than inferred from the
106
+ * spec's header parameters: `Idempotency-Key` is declared on the operations
107
+ * that honour it and `Forumulate-Version` applies to all of them, but the
108
+ * generated `paths` carries header params inconsistently across 1,225
109
+ * operations, and a type that refuses a legal header is worse than one that
110
+ * does not narrow it. Without this slot there was no way to send either, so
111
+ * `POST …/items` — which REQUIRES `Idempotency-Key` — could not be called at
112
+ * all from the typed surface that advertised it.
103
113
  */
104
114
  export type TypedRequestInit<Op> = Simplify<ParamsPart<Op> & QueryPart<Op> & BodyPart<Op> & {
105
115
  raw?: boolean;
116
+ headers?: Record<string, string>;
106
117
  }>;
107
118
  /** Pull the `application/json` payload out of one response entry. */
108
119
  type JsonBody<R> = R extends {
package/dist/typed.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"typed.d.ts","sourceRoot":"","sources":["../src/typed.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,kFAAkF;AAClF,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAEpG;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,KAAK,IAAI;KAC5C,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,SAAS,UAAU,GAAG,CAAC,GAAG,KAAK;CAC5F,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAElB,kEAAkE;AAClE,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,KAAK,EAAE,CAAC,SAAS,MAAM,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvF,mFAAmF;AACnF,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC;AAE3D,oFAAoF;AACpF,KAAK,UAAU,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC9D,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GACrB;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GACb;IAAE,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,GACxB;IAAE,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,KAAK,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC9D,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAClC;IAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;CAAE,GACzB;IAAE,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACvB,EAAE,SAAS;IAAE,UAAU,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC5C,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAClC;IAAE,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;CAAE,GAC1B;IAAE,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACvB;IAAE,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE5B;;;;GAIG;AACH,KAAK,QAAQ,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,WAAW,EAAE;QAAE,OAAO,EAAE;YAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACxF;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,GACX,EAAE,SAAS;IAAE,WAAW,CAAC,EAAE;QAAE,OAAO,EAAE;YAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACvE;IAAE,IAAI,CAAC,EAAE,CAAC,CAAA;CAAE,GACZ;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE3B,gFAAgF;AAChF,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE/G,qEAAqE;AACrE,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE;QAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,OAAO,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,SAAS,EAAE,MAAM,CAAC,CAAA;CAAE,GAC7D,GAAG,SAAS,MAAM,CAAC,GACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAChB,GAAG,SAAS,MAAM,CAAC,GACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAChB,GAAG,SAAS,MAAM,CAAC,GACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAChB,GAAG,SAAS,MAAM,CAAC,GACjB,SAAS,GACT,OAAO,GACf,OAAO,CAAC"}
1
+ {"version":3,"file":"typed.d.ts","sourceRoot":"","sources":["../src/typed.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC,YAAY,EAAE,KAAK,EAAE,CAAC;AAEtB,kFAAkF;AAClF,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAEpG;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,KAAK,IAAI;KAC5C,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,SAAS,UAAU,GAAG,CAAC,GAAG,KAAK;CAC5F,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAElB,kEAAkE;AAClE,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,KAAK,EAAE,CAAC,SAAS,MAAM,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvF,mFAAmF;AACnF,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC;AAE3D,oFAAoF;AACpF,KAAK,UAAU,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC9D,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GACrB;IAAE,MAAM,EAAE,CAAC,CAAA;CAAE,GACb;IAAE,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,GACxB;IAAE,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,KAAK,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC9D,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAClC;IAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;CAAE,GACzB;IAAE,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACvB,EAAE,SAAS;IAAE,UAAU,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC5C,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAClC;IAAE,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;CAAE,GAC1B;IAAE,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACvB;IAAE,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE5B;;;;GAIG;AACH,KAAK,QAAQ,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,WAAW,EAAE;QAAE,OAAO,EAAE;YAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACxF;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,GACX,EAAE,SAAS;IAAE,WAAW,CAAC,EAAE;QAAE,OAAO,EAAE;YAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GACvE;IAAE,IAAI,CAAC,EAAE,CAAC,CAAA;CAAE,GACZ;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAE3B,gFAAgF;AAChF,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAEjD;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,gBAAgB,CAAC,EAAE,IAAI,QAAQ,CACzC,UAAU,CAAC,EAAE,CAAC,GACZ,SAAS,CAAC,EAAE,CAAC,GACb,QAAQ,CAAC,EAAE,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CACrE,CAAC;AAEF,qEAAqE;AACrE,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE;QAAE,kBAAkB,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAAG,CAAC,GAAG,OAAO,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS;IAAE,SAAS,EAAE,MAAM,CAAC,CAAA;CAAE,GAC7D,GAAG,SAAS,MAAM,CAAC,GACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAChB,GAAG,SAAS,MAAM,CAAC,GACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAChB,GAAG,SAAS,MAAM,CAAC,GACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAChB,GAAG,SAAS,MAAM,CAAC,GACjB,SAAS,GACT,OAAO,GACf,OAAO,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forumulate/sdk",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "Typed TypeScript client for the Forumulate REST API.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://forumulate.com/reference",