@shopify/shopify-api 11.1.0 → 11.3.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 (149) hide show
  1. package/LICENSE.md +9 -0
  2. package/README.md +4 -3
  3. package/dist/cjs/future/flags.js +3 -0
  4. package/dist/cjs/future/flags.js.map +1 -1
  5. package/dist/cjs/lib/billing/cancel.js.map +1 -1
  6. package/dist/cjs/lib/billing/check.js +34 -46
  7. package/dist/cjs/lib/billing/check.js.map +1 -1
  8. package/dist/cjs/lib/billing/index.js.map +1 -1
  9. package/dist/cjs/lib/billing/request.js.map +1 -1
  10. package/dist/cjs/lib/billing/subscriptions.js +1 -1
  11. package/dist/cjs/lib/billing/subscriptions.js.map +1 -1
  12. package/dist/cjs/lib/clients/admin/graphql/client.js +7 -1
  13. package/dist/cjs/lib/clients/admin/graphql/client.js.map +1 -1
  14. package/dist/cjs/lib/clients/admin/rest/client.js +1 -0
  15. package/dist/cjs/lib/clients/admin/rest/client.js.map +1 -1
  16. package/dist/cjs/lib/config.js.map +1 -1
  17. package/dist/cjs/lib/index.js +20 -18
  18. package/dist/cjs/lib/index.js.map +1 -1
  19. package/dist/cjs/lib/session/session.js +10 -3
  20. package/dist/cjs/lib/session/session.js.map +1 -1
  21. package/dist/cjs/lib/utils/fetch-request.js.map +1 -1
  22. package/dist/cjs/lib/version.js +1 -1
  23. package/dist/cjs/lib/webhooks/process.js.map +1 -1
  24. package/dist/cjs/lib/webhooks/register.js.map +1 -1
  25. package/dist/cjs/lib/webhooks/types.js.map +1 -1
  26. package/dist/cjs/lib/webhooks/validate.js.map +1 -1
  27. package/dist/cjs/runtime/http/cookies.js +16 -8
  28. package/dist/cjs/runtime/http/cookies.js.map +1 -1
  29. package/dist/cjs/runtime/http/headers.js +2 -0
  30. package/dist/cjs/runtime/http/headers.js.map +1 -1
  31. package/dist/cjs/test-helpers/const.js +20 -0
  32. package/dist/cjs/test-helpers/const.js.map +1 -0
  33. package/dist/cjs/test-helpers/get-hmac.js +13 -0
  34. package/dist/cjs/test-helpers/get-hmac.js.map +1 -0
  35. package/dist/cjs/test-helpers/get-host-value.js +14 -0
  36. package/dist/cjs/test-helpers/get-host-value.js.map +1 -0
  37. package/dist/cjs/test-helpers/get-jwt.js +38 -0
  38. package/dist/cjs/test-helpers/get-jwt.js.map +1 -0
  39. package/dist/cjs/test-helpers/get-shop-value.js +14 -0
  40. package/dist/cjs/test-helpers/get-shop-value.js.map +1 -0
  41. package/dist/cjs/test-helpers/index.js +29 -0
  42. package/dist/cjs/test-helpers/index.js.map +1 -0
  43. package/dist/cjs/test-helpers/setup-valid-request.js +87 -0
  44. package/dist/cjs/test-helpers/setup-valid-request.js.map +1 -0
  45. package/dist/cjs/test-helpers/setup-valid-session.js +55 -0
  46. package/dist/cjs/test-helpers/setup-valid-session.js.map +1 -0
  47. package/dist/cjs/tsconfig.build.tsbuildinfo +1 -1
  48. package/dist/esm/future/flags.mjs +3 -0
  49. package/dist/esm/future/flags.mjs.map +1 -1
  50. package/dist/esm/lib/billing/cancel.mjs.map +1 -1
  51. package/dist/esm/lib/billing/check.mjs +34 -46
  52. package/dist/esm/lib/billing/check.mjs.map +1 -1
  53. package/dist/esm/lib/billing/index.mjs.map +1 -1
  54. package/dist/esm/lib/billing/request.mjs.map +1 -1
  55. package/dist/esm/lib/billing/subscriptions.mjs +1 -1
  56. package/dist/esm/lib/billing/subscriptions.mjs.map +1 -1
  57. package/dist/esm/lib/clients/admin/graphql/client.mjs +7 -1
  58. package/dist/esm/lib/clients/admin/graphql/client.mjs.map +1 -1
  59. package/dist/esm/lib/clients/admin/rest/client.mjs +1 -0
  60. package/dist/esm/lib/clients/admin/rest/client.mjs.map +1 -1
  61. package/dist/esm/lib/config.mjs.map +1 -1
  62. package/dist/esm/lib/index.mjs +1 -0
  63. package/dist/esm/lib/index.mjs.map +1 -1
  64. package/dist/esm/lib/session/session.mjs +10 -3
  65. package/dist/esm/lib/session/session.mjs.map +1 -1
  66. package/dist/esm/lib/utils/fetch-request.mjs.map +1 -1
  67. package/dist/esm/lib/version.mjs +1 -1
  68. package/dist/esm/lib/webhooks/process.mjs.map +1 -1
  69. package/dist/esm/lib/webhooks/register.mjs.map +1 -1
  70. package/dist/esm/lib/webhooks/types.mjs.map +1 -1
  71. package/dist/esm/lib/webhooks/validate.mjs.map +1 -1
  72. package/dist/esm/runtime/http/cookies.mjs +16 -8
  73. package/dist/esm/runtime/http/cookies.mjs.map +1 -1
  74. package/dist/esm/runtime/http/headers.mjs +2 -0
  75. package/dist/esm/runtime/http/headers.mjs.map +1 -1
  76. package/dist/esm/test-helpers/const.mjs +11 -0
  77. package/dist/esm/test-helpers/const.mjs.map +1 -0
  78. package/dist/esm/test-helpers/get-hmac.mjs +11 -0
  79. package/dist/esm/test-helpers/get-hmac.mjs.map +1 -0
  80. package/dist/esm/test-helpers/get-host-value.mjs +12 -0
  81. package/dist/esm/test-helpers/get-host-value.mjs.map +1 -0
  82. package/dist/esm/test-helpers/get-jwt.mjs +36 -0
  83. package/dist/esm/test-helpers/get-jwt.mjs.map +1 -0
  84. package/dist/esm/test-helpers/get-shop-value.mjs +12 -0
  85. package/dist/esm/test-helpers/get-shop-value.mjs.map +1 -0
  86. package/dist/esm/test-helpers/index.mjs +7 -0
  87. package/dist/esm/test-helpers/index.mjs.map +1 -0
  88. package/dist/esm/test-helpers/setup-valid-request.mjs +85 -0
  89. package/dist/esm/test-helpers/setup-valid-request.mjs.map +1 -0
  90. package/dist/esm/test-helpers/setup-valid-session.mjs +53 -0
  91. package/dist/esm/test-helpers/setup-valid-session.mjs.map +1 -0
  92. package/dist/esm/tsconfig.build.tsbuildinfo +1 -1
  93. package/dist/ts/future/flags.d.ts +4 -0
  94. package/dist/ts/future/flags.d.ts.map +1 -1
  95. package/dist/ts/lib/auth/oauth/types.d.ts +11 -0
  96. package/dist/ts/lib/auth/oauth/types.d.ts.map +1 -1
  97. package/dist/ts/lib/auth/types.d.ts +1 -0
  98. package/dist/ts/lib/auth/types.d.ts.map +1 -1
  99. package/dist/ts/lib/base-types.d.ts +5 -0
  100. package/dist/ts/lib/base-types.d.ts.map +1 -1
  101. package/dist/ts/lib/billing/cancel.d.ts +2 -2
  102. package/dist/ts/lib/billing/cancel.d.ts.map +1 -1
  103. package/dist/ts/lib/billing/check.d.ts +3 -2
  104. package/dist/ts/lib/billing/check.d.ts.map +1 -1
  105. package/dist/ts/lib/billing/index.d.ts +4 -7
  106. package/dist/ts/lib/billing/index.d.ts.map +1 -1
  107. package/dist/ts/lib/billing/request.d.ts +2 -2
  108. package/dist/ts/lib/billing/request.d.ts.map +1 -1
  109. package/dist/ts/lib/billing/subscriptions.d.ts +2 -2
  110. package/dist/ts/lib/billing/subscriptions.d.ts.map +1 -1
  111. package/dist/ts/lib/billing/types.d.ts +24 -3
  112. package/dist/ts/lib/billing/types.d.ts.map +1 -1
  113. package/dist/ts/lib/clients/admin/graphql/client.d.ts +3 -3
  114. package/dist/ts/lib/clients/admin/graphql/client.d.ts.map +1 -1
  115. package/dist/ts/lib/clients/admin/rest/client.d.ts.map +1 -1
  116. package/dist/ts/lib/clients/admin/types.d.ts +4 -1
  117. package/dist/ts/lib/clients/admin/types.d.ts.map +1 -1
  118. package/dist/ts/lib/clients/index.d.ts +1 -1
  119. package/dist/ts/lib/clients/index.d.ts.map +1 -1
  120. package/dist/ts/lib/index.d.ts +2 -2
  121. package/dist/ts/lib/index.d.ts.map +1 -1
  122. package/dist/ts/lib/session/session.d.ts +5 -1
  123. package/dist/ts/lib/session/session.d.ts.map +1 -1
  124. package/dist/ts/lib/version.d.ts +1 -1
  125. package/dist/ts/lib/webhooks/register.d.ts.map +1 -1
  126. package/dist/ts/lib/webhooks/types.d.ts +15 -11
  127. package/dist/ts/lib/webhooks/types.d.ts.map +1 -1
  128. package/dist/ts/runtime/http/cookies.d.ts +2 -0
  129. package/dist/ts/runtime/http/cookies.d.ts.map +1 -1
  130. package/dist/ts/runtime/http/headers.d.ts +1 -1
  131. package/dist/ts/runtime/http/headers.d.ts.map +1 -1
  132. package/dist/ts/test-helpers/const.d.ts +9 -0
  133. package/dist/ts/test-helpers/const.d.ts.map +1 -0
  134. package/dist/ts/test-helpers/get-hmac.d.ts +2 -0
  135. package/dist/ts/test-helpers/get-hmac.d.ts.map +1 -0
  136. package/dist/ts/test-helpers/get-host-value.d.ts +8 -0
  137. package/dist/ts/test-helpers/get-host-value.d.ts.map +1 -0
  138. package/dist/ts/test-helpers/get-jwt.d.ts +17 -0
  139. package/dist/ts/test-helpers/get-jwt.d.ts.map +1 -0
  140. package/dist/ts/test-helpers/get-shop-value.d.ts +8 -0
  141. package/dist/ts/test-helpers/get-shop-value.d.ts.map +1 -0
  142. package/dist/ts/test-helpers/index.d.ts +9 -0
  143. package/dist/ts/test-helpers/index.d.ts.map +1 -0
  144. package/dist/ts/test-helpers/setup-valid-request.d.ts +35 -0
  145. package/dist/ts/test-helpers/setup-valid-request.d.ts.map +1 -0
  146. package/dist/ts/test-helpers/setup-valid-session.d.ts +14 -0
  147. package/dist/ts/test-helpers/setup-valid-session.d.ts.map +1 -0
  148. package/dist/ts/tsconfig.build.tsbuildinfo +1 -1
  149. package/package.json +39 -31
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../test-helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,WAAW,EAAC,MAAM,uBAAuB,CAAC;AAClD,YAAY,EAAC,mBAAmB,EAAC,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACjC,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACnC,OAAO,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,OAAO,EACP,cAAc,EACd,OAAO,EACP,YAAY,EACZ,WAAW,EACX,cAAc,EACd,SAAS,EACT,OAAO,GACR,MAAM,SAAS,CAAC"}
@@ -0,0 +1,35 @@
1
+ export declare enum RequestType {
2
+ Admin = 0,
3
+ Bearer = 1,
4
+ Extension = 2,
5
+ Public = 3
6
+ }
7
+ interface ValidBaseRequestOptions {
8
+ type: RequestType.Admin | RequestType.Bearer;
9
+ store: string;
10
+ apiSecretKey: string;
11
+ apiKey: string;
12
+ }
13
+ interface ValidExtensionRequestOptions {
14
+ type: RequestType.Extension;
15
+ store: string;
16
+ apiSecretKey: string;
17
+ body?: any;
18
+ headers?: Record<string, string>;
19
+ }
20
+ interface ValidPublicRequestOptions {
21
+ type: RequestType.Public;
22
+ store: string;
23
+ apiSecretKey: string;
24
+ }
25
+ export type ValidRequestOptions = ValidBaseRequestOptions | ValidExtensionRequestOptions | ValidPublicRequestOptions;
26
+ /**
27
+ * Duplicates a Request object and decorates the duplicated object with fake authorization headers or query string parameters.
28
+ *
29
+ * @param {ValidRequestOptions} options Provides the type of authorization method to fake for the provided Request, and the inputs required to fake the authorization.
30
+ * @param {Request} request The Request object to be decorated with fake authorization headers or query string parameters.
31
+ * @returns {Request} A duplicate of the provided Request object with faked authorization headers or query string parameters.
32
+ */
33
+ export declare function setUpValidRequest(options: ValidRequestOptions, request: Request): Promise<Request>;
34
+ export {};
35
+ //# sourceMappingURL=setup-valid-request.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"setup-valid-request.d.ts","sourceRoot":"","sources":["../../../test-helpers/setup-valid-request.ts"],"names":[],"mappings":"AAOA,oBAAY,WAAW;IACrB,KAAK,IAAA;IACL,MAAM,IAAA;IACN,SAAS,IAAA;IACT,MAAM,IAAA;CACP;AAED,UAAU,uBAAuB;IAC/B,IAAI,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,4BAA4B;IACpC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,UAAU,yBAAyB;IACjC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,mBAAmB,GAC3B,uBAAuB,GACvB,4BAA4B,GAC5B,yBAAyB,CAAC;AAE9B;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,OAAO,oBAuCjB"}
@@ -0,0 +1,14 @@
1
+ import type { SessionParams } from '../lib/session/types';
2
+ import { Session } from '../lib/session/session';
3
+ type DeepPartial<T> = T extends object ? {
4
+ [P in keyof T]?: DeepPartial<T[P]>;
5
+ } : T;
6
+ /**
7
+ * Creates and returns a fake Session for the shop defined in sessionParams.
8
+ *
9
+ * @param sessionParams The Session parameters to use when creating the fake Session.
10
+ * @returns {Session} The fake Session created.
11
+ */
12
+ export declare function setUpValidSession(sessionParams: DeepPartial<SessionParams> & Pick<SessionParams, 'shop' | 'expires'>): Session;
13
+ export {};
14
+ //# sourceMappingURL=setup-valid-session.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"setup-valid-session.d.ts","sourceRoot":"","sources":["../../../test-helpers/setup-valid-session.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAK/C,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAClC;KAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAC,GACpC,CAAC,CAAC;AAEN;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,WAAW,CAAC,aAAa,CAAC,GACvC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC,GACxC,OAAO,CA2CT"}