@valtown/sdk 2.0.0 → 2.1.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 (73) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/index.d.mts +7 -3
  3. package/index.d.ts +7 -3
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/pagination.d.ts +20 -0
  9. package/pagination.d.ts.map +1 -1
  10. package/pagination.js +35 -1
  11. package/pagination.js.map +1 -1
  12. package/pagination.mjs +33 -0
  13. package/pagination.mjs.map +1 -1
  14. package/resources/index.d.ts +1 -1
  15. package/resources/index.d.ts.map +1 -1
  16. package/resources/index.js.map +1 -1
  17. package/resources/index.mjs.map +1 -1
  18. package/resources/search/index.d.ts +1 -1
  19. package/resources/search/index.d.ts.map +1 -1
  20. package/resources/search/index.js +1 -2
  21. package/resources/search/index.js.map +1 -1
  22. package/resources/search/index.mjs +1 -1
  23. package/resources/search/index.mjs.map +1 -1
  24. package/resources/search/search.d.ts +2 -2
  25. package/resources/search/search.d.ts.map +1 -1
  26. package/resources/search/search.js +0 -1
  27. package/resources/search/search.js.map +1 -1
  28. package/resources/search/search.mjs +1 -2
  29. package/resources/search/search.mjs.map +1 -1
  30. package/resources/search/vals.d.ts +6 -78
  31. package/resources/search/vals.d.ts.map +1 -1
  32. package/resources/search/vals.js +4 -7
  33. package/resources/search/vals.js.map +1 -1
  34. package/resources/search/vals.mjs +3 -5
  35. package/resources/search/vals.mjs.map +1 -1
  36. package/resources/shared.d.ts +161 -1
  37. package/resources/shared.d.ts.map +1 -1
  38. package/resources/shared.js +7 -1
  39. package/resources/shared.js.map +1 -1
  40. package/resources/shared.mjs +5 -1
  41. package/resources/shared.mjs.map +1 -1
  42. package/resources/vals/environment-variables.d.ts +137 -0
  43. package/resources/vals/environment-variables.d.ts.map +1 -0
  44. package/resources/vals/environment-variables.js +81 -0
  45. package/resources/vals/environment-variables.js.map +1 -0
  46. package/resources/vals/environment-variables.mjs +76 -0
  47. package/resources/vals/environment-variables.mjs.map +1 -0
  48. package/resources/vals/index.d.ts +2 -1
  49. package/resources/vals/index.d.ts.map +1 -1
  50. package/resources/vals/index.js +4 -1
  51. package/resources/vals/index.js.map +1 -1
  52. package/resources/vals/index.mjs +1 -0
  53. package/resources/vals/index.mjs.map +1 -1
  54. package/resources/vals/vals.d.ts +14 -18
  55. package/resources/vals/vals.d.ts.map +1 -1
  56. package/resources/vals/vals.js +13 -3
  57. package/resources/vals/vals.js.map +1 -1
  58. package/resources/vals/vals.mjs +12 -2
  59. package/resources/vals/vals.mjs.map +1 -1
  60. package/src/index.ts +13 -8
  61. package/src/pagination.ts +61 -0
  62. package/src/resources/index.ts +1 -1
  63. package/src/resources/search/index.ts +1 -1
  64. package/src/resources/search/search.ts +2 -8
  65. package/src/resources/search/vals.ts +8 -103
  66. package/src/resources/shared.ts +201 -1
  67. package/src/resources/vals/environment-variables.ts +199 -0
  68. package/src/resources/vals/index.ts +11 -1
  69. package/src/resources/vals/vals.ts +38 -26
  70. package/src/version.ts +1 -1
  71. package/version.d.ts +1 -1
  72. package/version.js +1 -1
  73. package/version.mjs +1 -1
@@ -1,16 +1,21 @@
1
1
  import { APIResource } from "../../resource.js";
2
2
  import * as Core from "../../core.js";
3
3
  import * as Shared from "../shared.js";
4
+ import { ValsCursor } from "../shared.js";
4
5
  import * as BranchesAPI from "./branches.js";
5
6
  import { BranchCreateParams, BranchCreateResponse, BranchListParams, BranchListResponse, BranchListResponsesPageCursorURL, BranchRetrieveResponse, Branches } from "./branches.js";
7
+ import * as EnvironmentVariablesAPI from "./environment-variables.js";
8
+ import { EnvironmentVariableCreateParams, EnvironmentVariableCreateResponse, EnvironmentVariableListParams, EnvironmentVariableListResponse, EnvironmentVariableListResponsesPageCursorURL, EnvironmentVariableUpdateParams, EnvironmentVariableUpdateResponse, EnvironmentVariables } from "./environment-variables.js";
6
9
  import * as FilesAPI from "./files.js";
7
10
  import { FileCreateParams, FileCreateResponse, FileDeleteParams, FileGetContentParams, FileRetrieveParams, FileRetrieveResponse, FileRetrieveResponsesPageCursorURL, FileUpdateParams, FileUpdateResponse, Files } from "./files.js";
11
+ import { type CursorParams } from "../../pagination.js";
8
12
  /**
9
13
  * Vals are a collaborative folder of runnable JavaScript, TypeScript, and JSX modules
10
14
  */
11
15
  export declare class Vals extends APIResource {
12
16
  branches: BranchesAPI.Branches;
13
17
  files: FilesAPI.Files;
18
+ environmentVariables: EnvironmentVariablesAPI.EnvironmentVariables;
14
19
  /**
15
20
  * Create a new val
16
21
  *
@@ -40,10 +45,13 @@ export declare class Vals extends APIResource {
40
45
  *
41
46
  * @example
42
47
  * ```ts
43
- * const vals = await client.vals.list({ limit: 1 });
48
+ * // Automatically fetches more pages as needed.
49
+ * for await (const val of client.vals.list({ limit: 1 })) {
50
+ * // ...
51
+ * }
44
52
  * ```
45
53
  */
46
- list(query: ValListParams, options?: Core.RequestOptions): Core.APIPromise<ValListResponse>;
54
+ list(query: ValListParams, options?: Core.RequestOptions): Core.PagePromise<ValsCursor, Shared.Val>;
47
55
  /**
48
56
  * Delete a project
49
57
  *
@@ -56,16 +64,6 @@ export declare class Vals extends APIResource {
56
64
  */
57
65
  delete(valId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
58
66
  }
59
- /**
60
- * A paginated result set
61
- */
62
- export interface ValListResponse {
63
- data: Array<Shared.Val>;
64
- /**
65
- * Links to use for pagination
66
- */
67
- links: Shared.PaginationLinks;
68
- }
69
67
  export interface ValCreateParams {
70
68
  name: string;
71
69
  privacy: 'public' | 'unlisted' | 'private';
@@ -75,15 +73,11 @@ export interface ValCreateParams {
75
73
  */
76
74
  orgId?: string;
77
75
  }
78
- export interface ValListParams {
76
+ export interface ValListParams extends CursorParams {
79
77
  /**
80
78
  * Maximum items to return in each paginated response
81
79
  */
82
80
  limit: number;
83
- /**
84
- * Cursor to start the pagination from
85
- */
86
- cursor?: string;
87
81
  /**
88
82
  * This resource's privacy setting. Unlisted resources do not appear on profile
89
83
  * pages or elsewhere, but you can link to them.
@@ -95,8 +89,10 @@ export interface ValListParams {
95
89
  user_id?: string;
96
90
  }
97
91
  export declare namespace Vals {
98
- export { type ValListResponse as ValListResponse, type ValCreateParams as ValCreateParams, type ValListParams as ValListParams, };
92
+ export { type ValCreateParams as ValCreateParams, type ValListParams as ValListParams };
99
93
  export { Branches as Branches, type BranchCreateResponse as BranchCreateResponse, type BranchRetrieveResponse as BranchRetrieveResponse, type BranchListResponse as BranchListResponse, BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL, type BranchCreateParams as BranchCreateParams, type BranchListParams as BranchListParams, };
100
94
  export { Files as Files, type FileCreateResponse as FileCreateResponse, type FileRetrieveResponse as FileRetrieveResponse, type FileUpdateResponse as FileUpdateResponse, FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileUpdateParams as FileUpdateParams, type FileDeleteParams as FileDeleteParams, type FileGetContentParams as FileGetContentParams, };
95
+ export { EnvironmentVariables as EnvironmentVariables, type EnvironmentVariableCreateResponse as EnvironmentVariableCreateResponse, type EnvironmentVariableUpdateResponse as EnvironmentVariableUpdateResponse, type EnvironmentVariableListResponse as EnvironmentVariableListResponse, EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL, type EnvironmentVariableCreateParams as EnvironmentVariableCreateParams, type EnvironmentVariableUpdateParams as EnvironmentVariableUpdateParams, type EnvironmentVariableListParams as EnvironmentVariableListParams, };
101
96
  }
97
+ export { ValsCursor };
102
98
  //# sourceMappingURL=vals.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"vals.d.ts","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,sBAAsB,EACtB,QAAQ,EACT,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,kCAAkC,EAClC,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACN,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAIzF;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAInF;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAI3F;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAM5E;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,eAAe,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAE3C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAOD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,gCAAgC,IAAI,gCAAgC,EACpE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,kCAAkC,IAAI,kCAAkC,EACxE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"vals.d.ts","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,sBAAsB,EACtB,QAAQ,EACT,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,uBAAuB,MAAM,yBAAyB,CAAC;AACnE,OAAO,EACL,+BAA+B,EAC/B,iCAAiC,EACjC,6BAA6B,EAC7B,+BAA+B,EAC/B,6CAA6C,EAC7C,+BAA+B,EAC/B,iCAAiC,EACjC,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,kCAAkC,EAClC,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,oBAAoB,EAAE,uBAAuB,CAAC,oBAAoB,CACD;IAEjE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAIzF;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAInF;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC;IAInG;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAM5E;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAE3C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AASD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;IAExF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,gCAAgC,IAAI,gCAAgC,EACpE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,kCAAkC,IAAI,kCAAkC,EACxE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,oBAAoB,IAAI,oBAAoB,EAC5C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,6CAA6C,IAAI,6CAA6C,EAC9F,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
@@ -24,10 +24,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
24
24
  return result;
25
25
  };
26
26
  Object.defineProperty(exports, "__esModule", { value: true });
27
- exports.Vals = void 0;
27
+ exports.ValsCursor = exports.Vals = void 0;
28
28
  const resource_1 = require("../../resource.js");
29
+ const shared_1 = require("../shared.js");
30
+ Object.defineProperty(exports, "ValsCursor", { enumerable: true, get: function () { return shared_1.ValsCursor; } });
29
31
  const BranchesAPI = __importStar(require("./branches.js"));
30
32
  const branches_1 = require("./branches.js");
33
+ const EnvironmentVariablesAPI = __importStar(require("./environment-variables.js"));
34
+ const environment_variables_1 = require("./environment-variables.js");
31
35
  const FilesAPI = __importStar(require("./files.js"));
32
36
  const files_1 = require("./files.js");
33
37
  /**
@@ -38,6 +42,7 @@ class Vals extends resource_1.APIResource {
38
42
  super(...arguments);
39
43
  this.branches = new BranchesAPI.Branches(this._client);
40
44
  this.files = new FilesAPI.Files(this._client);
45
+ this.environmentVariables = new EnvironmentVariablesAPI.EnvironmentVariables(this._client);
41
46
  }
42
47
  /**
43
48
  * Create a new val
@@ -72,11 +77,14 @@ class Vals extends resource_1.APIResource {
72
77
  *
73
78
  * @example
74
79
  * ```ts
75
- * const vals = await client.vals.list({ limit: 1 });
80
+ * // Automatically fetches more pages as needed.
81
+ * for await (const val of client.vals.list({ limit: 1 })) {
82
+ * // ...
83
+ * }
76
84
  * ```
77
85
  */
78
86
  list(query, options) {
79
- return this._client.get('/v2/vals', { query, ...options });
87
+ return this._client.getAPIList('/v2/vals', shared_1.ValsCursor, { query, ...options });
80
88
  }
81
89
  /**
82
90
  * Delete a project
@@ -100,4 +108,6 @@ Vals.Branches = branches_1.Branches;
100
108
  Vals.BranchListResponsesPageCursorURL = branches_1.BranchListResponsesPageCursorURL;
101
109
  Vals.Files = files_1.Files;
102
110
  Vals.FileRetrieveResponsesPageCursorURL = files_1.FileRetrieveResponsesPageCursorURL;
111
+ Vals.EnvironmentVariables = environment_variables_1.EnvironmentVariables;
112
+ Vals.EnvironmentVariableListResponsesPageCursorURL = environment_variables_1.EnvironmentVariableListResponsesPageCursorURL;
103
113
  //# sourceMappingURL=vals.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"vals.js","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAG7C,2DAA0C;AAC1C,4CAQoB;AACpB,qDAAoC;AACpC,sCAWiB;AAEjB;;GAEG;AACH,MAAa,IAAK,SAAQ,sBAAW;IAArC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4D3D,CAAC;IA1DC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,KAAoB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,oBA8DC;AAkDD,IAAI,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACzB,IAAI,CAAC,gCAAgC,GAAG,2CAAgC,CAAC;AACzE,IAAI,CAAC,KAAK,GAAG,aAAK,CAAC;AACnB,IAAI,CAAC,kCAAkC,GAAG,0CAAkC,CAAC"}
1
+ {"version":3,"file":"vals.js","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAG7C,yCAAuC;AAyL9B,2FAzLA,mBAAU,OAyLA;AAxLnB,2DAA0C;AAC1C,4CAQoB;AACpB,oFAAmE;AACnE,sEASiC;AACjC,qDAAoC;AACpC,sCAWiB;AAGjB;;GAEG;AACH,MAAa,IAAK,SAAQ,sBAAW;IAArC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,yBAAoB,GAClB,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+DnE,CAAC;IA7DC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAoB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAnED,oBAmEC;AAiCD,IAAI,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACzB,IAAI,CAAC,gCAAgC,GAAG,2CAAgC,CAAC;AACzE,IAAI,CAAC,KAAK,GAAG,aAAK,CAAC;AACnB,IAAI,CAAC,kCAAkC,GAAG,0CAAkC,CAAC;AAC7E,IAAI,CAAC,oBAAoB,GAAG,4CAAoB,CAAC;AACjD,IAAI,CAAC,6CAA6C,GAAG,qEAA6C,CAAC"}
@@ -1,7 +1,10 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../../resource.mjs";
3
+ import { ValsCursor } from "../shared.mjs";
3
4
  import * as BranchesAPI from "./branches.mjs";
4
5
  import { BranchListResponsesPageCursorURL, Branches, } from "./branches.mjs";
6
+ import * as EnvironmentVariablesAPI from "./environment-variables.mjs";
7
+ import { EnvironmentVariableListResponsesPageCursorURL, EnvironmentVariables, } from "./environment-variables.mjs";
5
8
  import * as FilesAPI from "./files.mjs";
6
9
  import { FileRetrieveResponsesPageCursorURL, Files, } from "./files.mjs";
7
10
  /**
@@ -12,6 +15,7 @@ export class Vals extends APIResource {
12
15
  super(...arguments);
13
16
  this.branches = new BranchesAPI.Branches(this._client);
14
17
  this.files = new FilesAPI.Files(this._client);
18
+ this.environmentVariables = new EnvironmentVariablesAPI.EnvironmentVariables(this._client);
15
19
  }
16
20
  /**
17
21
  * Create a new val
@@ -46,11 +50,14 @@ export class Vals extends APIResource {
46
50
  *
47
51
  * @example
48
52
  * ```ts
49
- * const vals = await client.vals.list({ limit: 1 });
53
+ * // Automatically fetches more pages as needed.
54
+ * for await (const val of client.vals.list({ limit: 1 })) {
55
+ * // ...
56
+ * }
50
57
  * ```
51
58
  */
52
59
  list(query, options) {
53
- return this._client.get('/v2/vals', { query, ...options });
60
+ return this._client.getAPIList('/v2/vals', ValsCursor, { query, ...options });
54
61
  }
55
62
  /**
56
63
  * Delete a project
@@ -73,4 +80,7 @@ Vals.Branches = Branches;
73
80
  Vals.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
74
81
  Vals.Files = Files;
75
82
  Vals.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
83
+ Vals.EnvironmentVariables = EnvironmentVariables;
84
+ Vals.EnvironmentVariableListResponsesPageCursorURL = EnvironmentVariableListResponsesPageCursorURL;
85
+ export { ValsCursor };
76
86
  //# sourceMappingURL=vals.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"vals.mjs","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,WAAW;OAChB,EAKL,gCAAgC,EAEhC,QAAQ,GACT;OACM,KAAK,QAAQ;OACb,EAOL,kCAAkC,EAGlC,KAAK,GACN;AAED;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IAArC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4D3D,CAAC;IA1DC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,KAAoB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAkDD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzB,IAAI,CAAC,gCAAgC,GAAG,gCAAgC,CAAC;AACzE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;AACnB,IAAI,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}
1
+ {"version":3,"file":"vals.mjs","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAE;OACd,KAAK,WAAW;OAChB,EAKL,gCAAgC,EAEhC,QAAQ,GACT;OACM,KAAK,uBAAuB;OAC5B,EAKL,6CAA6C,EAG7C,oBAAoB,GACrB;OACM,KAAK,QAAQ;OACb,EAOL,kCAAkC,EAGlC,KAAK,GACN;AAGD;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IAArC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,yBAAoB,GAClB,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+DnE,CAAC;IA7DC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAoB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAiCD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzB,IAAI,CAAC,gCAAgC,GAAG,gCAAgC,CAAC;AACzE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;AACnB,IAAI,CAAC,kCAAkC,GAAG,kCAAkC,CAAC;AAC7E,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;AACjD,IAAI,CAAC,6CAA6C,GAAG,6CAA6C,CAAC;AAwCnG,OAAO,EAAE,UAAU,EAAE,CAAC"}
package/src/index.ts CHANGED
@@ -5,7 +5,12 @@ import * as qs from './internal/qs';
5
5
  import * as Core from './core';
6
6
  import * as Errors from './error';
7
7
  import * as Pagination from './pagination';
8
- import { type PageCursorURLParams, PageCursorURLResponse } from './pagination';
8
+ import {
9
+ type CursorParams,
10
+ CursorResponse,
11
+ type PageCursorURLParams,
12
+ PageCursorURLResponse,
13
+ } from './pagination';
9
14
  import * as Uploads from './uploads';
10
15
  import * as API from './resources/index';
11
16
  import { BlobListParams, BlobListResponse, BlobStoreParams, Blobs } from './resources/blobs';
@@ -18,7 +23,7 @@ import { Alias } from './resources/alias/alias';
18
23
  import { Me } from './resources/me/me';
19
24
  import { Search } from './resources/search/search';
20
25
  import { Telemetry } from './resources/telemetry/telemetry';
21
- import { ValCreateParams, ValListParams, ValListResponse, Vals } from './resources/vals/vals';
26
+ import { ValCreateParams, ValListParams, Vals } from './resources/vals/vals';
22
27
 
23
28
  export interface ClientOptions {
24
29
  /**
@@ -250,6 +255,9 @@ export declare namespace ValTown {
250
255
  type PageCursorURLResponse as PageCursorURLResponse,
251
256
  };
252
257
 
258
+ export import Cursor = Pagination.Cursor;
259
+ export { type CursorParams as CursorParams, type CursorResponse as CursorResponse };
260
+
253
261
  export { Search as Search };
254
262
 
255
263
  export { Alias as Alias };
@@ -281,12 +289,7 @@ export declare namespace ValTown {
281
289
 
282
290
  export { Telemetry as Telemetry };
283
291
 
284
- export {
285
- Vals as Vals,
286
- type ValListResponse as ValListResponse,
287
- type ValCreateParams as ValCreateParams,
288
- type ValListParams as ValListParams,
289
- };
292
+ export { Vals as Vals, type ValCreateParams as ValCreateParams, type ValListParams as ValListParams };
290
293
 
291
294
  export { Files as Files, type FileRetrieveResponse as FileRetrieveResponse };
292
295
 
@@ -296,6 +299,8 @@ export declare namespace ValTown {
296
299
  type EmailSendParams as EmailSendParams,
297
300
  };
298
301
 
302
+ export type BasicVal = API.BasicVal;
303
+ export type ExtendedVal = API.ExtendedVal;
299
304
  export type PaginationLinks = API.PaginationLinks;
300
305
  export type ResultSet = API.ResultSet;
301
306
  export type User = API.User;
package/src/pagination.ts CHANGED
@@ -60,3 +60,64 @@ export class PageCursorURL<Item> extends AbstractPage<Item> implements PageCurso
60
60
  return { url: new URL(url) };
61
61
  }
62
62
  }
63
+
64
+ export interface CursorResponse<Item> {
65
+ data: Array<Item>;
66
+
67
+ links: CursorResponse.Links;
68
+ }
69
+
70
+ export namespace CursorResponse {
71
+ export interface Links {
72
+ next?: string;
73
+ }
74
+ }
75
+
76
+ export interface CursorParams {
77
+ cursor?: string;
78
+ }
79
+
80
+ export class Cursor<Item> extends AbstractPage<Item> implements CursorResponse<Item> {
81
+ data: Array<Item>;
82
+
83
+ links: CursorResponse.Links;
84
+
85
+ constructor(
86
+ client: APIClient,
87
+ response: Response,
88
+ body: CursorResponse<Item>,
89
+ options: FinalRequestOptions,
90
+ ) {
91
+ super(client, response, body, options);
92
+
93
+ this.data = body.data || [];
94
+ this.links = body.links || {};
95
+ }
96
+
97
+ getPaginatedItems(): Item[] {
98
+ return this.data ?? [];
99
+ }
100
+
101
+ // @deprecated Please use `nextPageInfo()` instead
102
+ nextPageParams(): Partial<CursorParams> | null {
103
+ const info = this.nextPageInfo();
104
+ if (!info) return null;
105
+ if ('params' in info) return info.params;
106
+ const params = Object.fromEntries(info.url.searchParams);
107
+ if (!Object.keys(params).length) return null;
108
+ return params;
109
+ }
110
+
111
+ nextPageInfo(): PageInfo | null {
112
+ const cursor = this.links?.next;
113
+ if (!cursor) {
114
+ return null;
115
+ }
116
+
117
+ return {
118
+ params: {
119
+ cursor,
120
+ },
121
+ };
122
+ }
123
+ }
@@ -11,4 +11,4 @@ export { Search } from './search/search';
11
11
  export { Sqlite, type SqliteBatchResponse, type SqliteBatchParams, type SqliteExecuteParams } from './sqlite';
12
12
  export { Telemetry } from './telemetry/telemetry';
13
13
  export { Users } from './users';
14
- export { Vals, type ValListResponse, type ValCreateParams, type ValListParams } from './vals/vals';
14
+ export { Vals, type ValCreateParams, type ValListParams } from './vals/vals';
@@ -1,4 +1,4 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  export { Search } from './search';
4
- export { ValListResponsesPageCursorURL, Vals, type ValListResponse, type ValListParams } from './vals';
4
+ export { Vals, type ValListParams } from './vals';
@@ -2,7 +2,7 @@
2
2
 
3
3
  import { APIResource } from '../../resource';
4
4
  import * as ValsAPI from './vals';
5
- import { ValListParams, ValListResponse, ValListResponsesPageCursorURL, Vals } from './vals';
5
+ import { ValListParams, Vals } from './vals';
6
6
 
7
7
  /**
8
8
  * Search endpoint for vals
@@ -12,13 +12,7 @@ export class Search extends APIResource {
12
12
  }
13
13
 
14
14
  Search.Vals = Vals;
15
- Search.ValListResponsesPageCursorURL = ValListResponsesPageCursorURL;
16
15
 
17
16
  export declare namespace Search {
18
- export {
19
- Vals as Vals,
20
- type ValListResponse as ValListResponse,
21
- ValListResponsesPageCursorURL as ValListResponsesPageCursorURL,
22
- type ValListParams as ValListParams,
23
- };
17
+ export { Vals as Vals, type ValListParams as ValListParams };
24
18
  }
@@ -2,7 +2,9 @@
2
2
 
3
3
  import { APIResource } from '../../resource';
4
4
  import * as Core from '../../core';
5
- import { PageCursorURL, type PageCursorURLParams } from '../../pagination';
5
+ import * as Shared from '../shared';
6
+ import { BasicValsPageCursorURL } from '../shared';
7
+ import { type PageCursorURLParams } from '../../pagination';
6
8
 
7
9
  export class Vals extends APIResource {
8
10
  /**
@@ -11,101 +13,8 @@ export class Vals extends APIResource {
11
13
  list(
12
14
  query: ValListParams,
13
15
  options?: Core.RequestOptions,
14
- ): Core.PagePromise<ValListResponsesPageCursorURL, ValListResponse> {
15
- return this._client.getAPIList('/v1/search/vals', ValListResponsesPageCursorURL, { query, ...options });
16
- }
17
- }
18
-
19
- export class ValListResponsesPageCursorURL extends PageCursorURL<ValListResponse> {}
20
-
21
- /**
22
- * A Val
23
- */
24
- export interface ValListResponse {
25
- /**
26
- * This val's id
27
- */
28
- id: string;
29
-
30
- /**
31
- * The user who created this val
32
- */
33
- author: ValListResponse.Author | null;
34
-
35
- /**
36
- * TypeScript code associated with this val
37
- */
38
- code: string | null;
39
-
40
- createdAt: string;
41
-
42
- links: ValListResponse.Links;
43
-
44
- /**
45
- * The name of this val
46
- */
47
- name: string;
48
-
49
- /**
50
- * This resource's privacy setting. Unlisted resources do not appear on profile
51
- * pages or elsewhere, but you can link to them.
52
- */
53
- privacy: 'public' | 'unlisted' | 'private';
54
-
55
- /**
56
- * Whether this val is available publicly on Val Town
57
- */
58
- public: boolean;
59
-
60
- /**
61
- * The type of a val. HTTP can receive web requests, Email can receive emails, Cron
62
- * runs periodically, and Script can be used for libraries or one-off calculations
63
- */
64
- type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc' | 'httpnext';
65
-
66
- updatedAt: string;
67
-
68
- /**
69
- * The URL of this resource on the Val Town website
70
- */
71
- url: string;
72
-
73
- /**
74
- * The version of this val, starting at zero
75
- */
76
- version: number;
77
- }
78
-
79
- export namespace ValListResponse {
80
- /**
81
- * The user who created this val
82
- */
83
- export interface Author {
84
- id: string;
85
-
86
- username: string | null;
87
- }
88
-
89
- export interface Links {
90
- /**
91
- * The URL of this Val's source code as a module
92
- */
93
- module: string;
94
-
95
- /**
96
- * The URL of this val on this API
97
- */
98
- self: string;
99
-
100
- /**
101
- * The endpoint to retrieve this val's versions
102
- */
103
- versions: string;
104
-
105
- /**
106
- * This val's web endpoint, where it serves a website or API
107
- */
108
- endpoint?: string;
16
+ ): Core.PagePromise<BasicValsPageCursorURL, Shared.BasicVal> {
17
+ return this._client.getAPIList('/v1/search/vals', BasicValsPageCursorURL, { query, ...options });
109
18
  }
110
19
  }
111
20
 
@@ -116,12 +25,8 @@ export interface ValListParams extends PageCursorURLParams {
116
25
  query: string;
117
26
  }
118
27
 
119
- Vals.ValListResponsesPageCursorURL = ValListResponsesPageCursorURL;
120
-
121
28
  export declare namespace Vals {
122
- export {
123
- type ValListResponse as ValListResponse,
124
- ValListResponsesPageCursorURL as ValListResponsesPageCursorURL,
125
- type ValListParams as ValListParams,
126
- };
29
+ export { type ValListParams as ValListParams };
127
30
  }
31
+
32
+ export { BasicValsPageCursorURL };