@0xkey-io/telegram-cloud-storage-stamper 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# @0xkey-io/telegram-cloud-storage-stamper
+
+## 0.1.0
+
+Initial release.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 0xkey
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,197 @@
+# @0xkey-io/telegram-cloud-storage-stamper
+
+[![npm](https://img.shields.io/npm/v/@0xkey-io/telegram-cloud-storage-stamper?color=%234C48FF)](https://www.npmjs.com/package/@0xkey-io/telegram-cloud-storage-stamper)
+
+This package contains functions to store ZeroXKey API public/private keys and arbitrary data within [Telegram Cloud Storage](https://core.telegram.org/bots/webapps#cloudstorage). This package also handles stamping a ZeroXKey request with an API key. It is meant to be used with [`@0xkey-io/sdk-browser`](https://www.npmjs.com/package/@0xkey-io/sdk-browser).
+
+### Preqrequisites
+
+Telegram Bot API >= 6.9
+
+### About
+
+The Telegram Cloud Storage Stamper has a few different modes of operation, namely a classic [stamper](https://docs.0xkey.com/developer-reference/api-overview/stamps) for stamping requests made to ZeroXKey's API, and an interface for a Telegram Mini App built with ZeroXKey to interact with Telegram Cloud Storage. This provides the developer of the application utilities such as creating stamps on requests made by users, storing user API keys, storing temporary keys that are needed for decrypting credential bundles for activites like [email auth](https://docs.0xkey.com/features/email-auth) or [oauth](https://docs.0xkey.com/features/oauth), or storing arbitrary values that would be helpful to have saved for a user from session to session on device to device.
+
+The Telegram Cloud Storage Stamper will, by default, store the API key used for signing in Telegram Cloud Storage under the key `ZEROXKEY_API_KEY`. A Cloud Storage "key" is the index under which a value is stored in Telegram Cloud Storage. This can be changed when using the `.create()` or `.setSigningKey()` functions. An API key is stored within Cloud Storage as a JSON string of the following object:
+
+```
+{
+  apiPublicKey: "compressedApiPublicKeyHex",
+  apiPrivateKey: "apiPrivateKeyHex",
+}
+```
+
+#### Argument Usage
+
+The `.create()` and `.setSigningKey()` functions take one of the following 4 sets of arguments:
+
+- No arguments: Use an API key at the default location within Telegram Cloud Storage `ZEROXKEY_API_KEY` and set that as the signing key
+- Just an API key: Store the passed in API key at the default Telegram Cloud Storage location and set that as the signing key
+- Just a Cloud Storage key: Use an API key stored at the specified Telegram Cloud Storage key location and set that as the signing key
+- Both an API key and a Cloud Storage key: Store the passed API key at the specified Telegram Cloud Storage key location and set that as the signing key
+
+The `.getAPIKey()` and `.setAPIKey()` functions operate in a similar manner taking an optional `key` parameter that will be used to `get` or `set` the API key at that location if it is passed, or at the default location if it is not passed.
+
+The following section will describe the usage of the helper functions provided for interfacing with Telegram Cloud Storage. These functions return null if there is no value when trying to retrieve an item from Cloud Storage.
+
+### Usage
+
+Insert a new API key into Telegram Cloud Storage at the default API key location
+
+```ts
+import TelegramCloudStorageStamper, { CloudStorageAPIKey } from "@0xkey-io/telegram-cloud-storage-stamper";
+import { generateP256KeyPair } from "@0xkey-io/crypto";
+import { ZeroXKeyBrowserClient, ZeroXKeySDKClientConfig } from "@0xkey-io/sdk-browser";
+
+// generate an API keypair
+const keyPair = generateP256KeyPair();
+
+// the API key to be stored
+const apiKey: CloudStorageAPIKey = {
+  apiPublicKey: keyPair.publicKey,
+  apiPrivateKey: keyPair.privateKey,
+}
+
+// create a new Telegram Cloud Storage Stamper
+const stamper = await TelegramCloudStorageStamper.create({
+  cloudStorageAPIKey: apiKey
+})
+
+// use the stamper in the client config
+const browserConfig: ZeroXKeySDKClientConfig = {
+  stamper: stamper,
+  apiBaseUrl: "https://api.0xkey.com",
+  organizationId: <ORGANIZATION_ID>,
+};
+
+// create a ZeroXKeyClient with the initialized Telegram Cloud Storage Stamper
+const client = new ZeroXKeyBrowserClient(browserConfig);
+
+// make a request with the client
+const whoamiResponse = await client.getWhoami({
+  organizationId: <ORGANIZATION_ID>,
+});
+```
+
+Use an existing key that has been previously stored in Telegram Cloud Storage at the default API key location key location
+
+```ts
+import TelegramCloudStorageStamper from "@0xkey-io/telegram-cloud-storage-stamper";
+import { ZeroXKeyBrowserClient, ZeroXKeySDKClientConfig } from "@0xkey-io/sdk-browser";
+
+// create a new Telegram Cloud Storage stamper
+const stamper = await TelegramCloudStorageStamper.create();
+
+// use the stamper in the client config
+const browserConfig: ZeroXKeySDKClientConfig = {
+  stamper: stamper,
+  apiBaseUrl: "https://api.0xkey.com",
+  organizationId: <ORGANIZATION_ID>,
+};
+
+// create a ZeroXKeyClient with the initialized Telegram Cloud Storage Stamper
+const client = new ZeroXKeyBrowserClient(browserConfig);
+
+// make a request with the client
+const whoamiResponse = await client.getWhoami({
+  organizationId: <ORGANIZATION_ID>,
+});
+```
+
+View an entry in Telegram Cloud Storage without inserting an API key, note the usage difference between the `new` and `.create()` here. `.create()` will do the work of getting/setting an API key in Cloud Storage whereas `new` will not
+
+```ts
+import TelegramCloudStorageStamper, {
+  CloudStorageAPIKey,
+} from "@0xkey-io/telegram-cloud-storage-stamper";
+
+// create a new Telegram Cloud Storage Stamper, "new" is used when you don't want to store or retrieve any API keys, and just need an interface into Cloud Storage
+const stamper = new TelegramCloudStorageStamper();
+
+// the key used to index Telegram Cloud Storage
+const telegramCloudStorageKey = "@0xkey-io/telegramCloudStorageKey";
+
+// get the item stored in Telegram Cloud Storage returned as a string
+const item = await stamper.getItem(telegramCloudStorageKey);
+
+if (!item) {
+  // failed retrieving item
+}
+```
+
+Insert a new API key into Cloud Storage at a specified key. This is just storing an API key, without using `.setSigningKey()` the key will not be used for signing.
+
+```ts
+import TelegramCloudStorageStamper from "@0xkey-io/telegram-cloud-storage-stamper";
+
+// create a new Telegram Cloud Storage Stamper
+const stamper = new TelegramCloudStorageStamper();
+
+const apiPublicKey = "...";
+const apiPrivateKey = "...";
+
+// the key used to index Telegram Cloud Storage
+const telegramCloudStorageKey = "@0xkey-io/telegramCloudStorageKey";
+
+// insert the API key in Telegram Cloud Storage
+await stamper.insertAPIKey(
+  apiPublicKey,
+  apiPrivateKey,
+  telegramCloudStorageKey,
+);
+```
+
+Set a new API key as the signing key for the stamper at a specified key. This will also insert the API key to that location within Telegram CloudStorage. Any subsequent requests for stamping will sign with this API key. The API key and CloudStorage key can also be omitted and the API key at the default location `ZEROXKEY_API_KEY` will be used. If an API key is omitted and a CloudStorage key is specified an API key at that location will be used. Refer to the [argument-usage](#argument-usage) section for a full explanation. A stamper that was originally used to just view Cloud Storage values can later be used for signing by using the `.setSigningKey()` function.
+
+```ts
+import TelegramCloudStorageStamper, {
+  CloudStorageAPIKey,
+} from "@0xkey-io/telegram-cloud-storage-stamper";
+
+// the API key to be set as the signing key
+const apiKey: CloudStorageAPIKey = {
+  apiPublicKey: "...",
+  apiPrivateKey: "...",
+};
+
+// create a new Telegram Cloud Storage Stamper
+const stamper = new TelegramCloudStorageStamper();
+
+// the key used to index Telegram Cloud Storage
+const telegramCloudStorageKey = "@0xkey-io/telegramCloudStorageKey";
+
+// insert the API key in Telegram Cloud Storage
+await stamper.setSigningKey({
+  cloudStorageAPIKey: apiKey,
+  cloudStorageKey: telegramCloudStorageKey,
+});
+```
+
+Set a new API key as the signing key for the stamper that previously had a different key set for the stamper.
+
+```ts
+import TelegramCloudStorageStamper, {
+  CloudStorageAPIKey,
+} from "@0xkey-io/telegram-cloud-storage-stamper";
+
+// the API key to be stored
+const apiKey: CloudStorageAPIKey = {
+  apiPublicKey: "...",
+  apiPrivateKey: "...",
+};
+
+// the API key to be set as the signing key
+const stamper = await TelegramCloudStorageStamper.create({
+  cloudStorageAPIKey: apiKey,
+});
+
+const apiKey2: CloudStorageAPIKey = {
+  apiPublicKey: "...",
+  apiPrivateKey: "...",
+};
+
+// insert the API key in Telegram Cloud Storage
+await stamper.setSigningKey({
+  cloudStorageAPIKey: apiKey2,
+});
+```

package/dist/__mocks__/telegram-environment.d.ts

@@ -0,0 +1,7 @@
+import JSDOMEnvironment from "jest-environment-jsdom";
+declare class TelegramEnvironment extends JSDOMEnvironment {
+    setup(): Promise<void>;
+    teardown(): Promise<void>;
+}
+export default TelegramEnvironment;
+//# sourceMappingURL=telegram-environment.d.ts.map

package/dist/__mocks__/telegram-environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telegram-environment.d.ts","sourceRoot":"","sources":["../../src/__mocks__/telegram-environment.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AAEtD,cAAM,mBAAoB,SAAQ,gBAAgB;IACjC,KAAK;IAUL,QAAQ;CAGxB;AAED,eAAe,mBAAmB,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,7 @@
+export declare class TelegramCloudStorageStamperError extends Error {
+    constructor(message: string);
+}
+export declare class TelegramSuccessButFalseError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,gCAAiC,SAAQ,KAAK;gBAC7C,OAAO,EAAE,MAAM;CAG5B;AAID,qBAAa,4BAA6B,SAAQ,KAAK;gBACzC,OAAO,EAAE,MAAM;CAG5B"}

package/dist/errors.js

@@ -0,0 +1,18 @@
+'use strict';
+
+class TelegramCloudStorageStamperError extends Error {
+    constructor(message) {
+        super(`TelegramCloudStorageStamperError: ${message}`);
+    }
+}
+// This error type is for when telegram cloud storage operations return as "no error" but return false in the case of clearing or setting an item
+// We were unable to get this value to ever be false, but Telegram's documentation notes that it can happen: https://core.telegram.org/bots/webapps#cloudstorage
+class TelegramSuccessButFalseError extends Error {
+    constructor(message) {
+        super(`TelegramSuccessButFalseError: ${message}`);
+    }
+}
+
+exports.TelegramCloudStorageStamperError = TelegramCloudStorageStamperError;
+exports.TelegramSuccessButFalseError = TelegramSuccessButFalseError;
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAM,MAAO,gCAAiC,SAAQ,KAAK,CAAA;AACzD,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,kCAAA,EAAqC,OAAO,CAAA,CAAE,CAAC;IACvD;AACD;AAED;AACA;AACM,MAAO,4BAA6B,SAAQ,KAAK,CAAA;AACrD,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,8BAAA,EAAiC,OAAO,CAAA,CAAE,CAAC;IACnD;AACD;;;;;"}

package/dist/errors.mjs

@@ -0,0 +1,15 @@
+class TelegramCloudStorageStamperError extends Error {
+    constructor(message) {
+        super(`TelegramCloudStorageStamperError: ${message}`);
+    }
+}
+// This error type is for when telegram cloud storage operations return as "no error" but return false in the case of clearing or setting an item
+// We were unable to get this value to ever be false, but Telegram's documentation notes that it can happen: https://core.telegram.org/bots/webapps#cloudstorage
+class TelegramSuccessButFalseError extends Error {
+    constructor(message) {
+        super(`TelegramSuccessButFalseError: ${message}`);
+    }
+}
+
+export { TelegramCloudStorageStamperError, TelegramSuccessButFalseError };
+//# sourceMappingURL=errors.mjs.map

package/dist/errors.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.mjs","sources":["../src/errors.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAM,MAAO,gCAAiC,SAAQ,KAAK,CAAA;AACzD,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,kCAAA,EAAqC,OAAO,CAAA,CAAE,CAAC;IACvD;AACD;AAED;AACA;AACM,MAAO,4BAA6B,SAAQ,KAAK,CAAA;AACrD,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,CAAA,8BAAA,EAAiC,OAAO,CAAA,CAAE,CAAC;IACnD;AACD;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+/// <reference lib="dom" />
+import { ApiKeyStamper } from "@0xkey-io/api-key-stamper";
+declare global {
+    interface Window {
+        Telegram: any;
+    }
+}
+export type TTelegramCloudStorageStamperConfig = {
+    cloudStorageAPIKey?: CloudStorageAPIKey;
+    cloudStorageKey?: string;
+};
+export type CloudStorageAPIKey = {
+    apiPublicKey: string;
+    apiPrivateKey: string;
+};
+export declare const DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY = "ZEROXKEY_API_KEY";
+/**
+ * Stamper to use within a `ZeroXKeyClient`
+ */
+export declare class TelegramCloudStorageStamper {
+    stamper?: ApiKeyStamper | undefined;
+    constructor();
+    static create(config?: TTelegramCloudStorageStamperConfig): Promise<TelegramCloudStorageStamper>;
+    stamp(payload: string): Promise<{
+        stampHeaderName: "X-Stamp";
+        stampHeaderValue: string;
+    }>;
+    setSigningKey(config?: TTelegramCloudStorageStamperConfig): Promise<void>;
+    insertAPIKey(apiPublicKey: string, apiPrivateKey: string, key?: string): Promise<void>;
+    getAPIKey(key?: string): Promise<CloudStorageAPIKey | null>;
+    checkTelegramContext(): void;
+    stringifyAPIKey(apiPublicKey: string, apiPrivateKey: string): string;
+    parseAPIKey(apiKey: string): {
+        apiPublicKey: any;
+        apiPrivateKey: any;
+    } | null;
+    isCloudStorageAPIKey(apiKey: CloudStorageAPIKey): boolean;
+    getItem(key: string): Promise<string>;
+    setItem(key: string, value: string): Promise<void>;
+    clearItem(key: string): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAM1D,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,QAAQ,EAAE,GAAG,CAAC;KACf;CACF;AAGD,MAAM,MAAM,kCAAkC,GAAG;IAC/C,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAGF,eAAO,MAAM,kCAAkC,qBAAqB,CAAC;AAErE;;GAEG;AACH,qBAAa,2BAA2B;IAEtC,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;;WASvB,MAAM,CAAC,MAAM,CAAC,EAAE,kCAAkC;IAQzD,KAAK,CAAC,OAAO,EAAE,MAAM;;;;IAerB,aAAa,CAAC,MAAM,CAAC,EAAE,kCAAkC;IA2DzD,YAAY,CAChB,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,GAAG,GAAE,MAA2C;IAQ5C,SAAS,CACb,GAAG,GAAE,MAA2C,GAC/C,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAcrC,oBAAoB;IAQpB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAO3D,WAAW,CAAC,MAAM,EAAE,MAAM;;;;IAoB1B,oBAAoB,CAAC,MAAM,EAAE,kBAAkB;IAOzC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAqBrC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IA8BlC,SAAS,CAAC,GAAG,EAAE,MAAM;CA4B5B"}

package/dist/index.js

@@ -0,0 +1,168 @@
+'use strict';
+
+var apiKeyStamper = require('@0xkey-io/api-key-stamper');
+var errors = require('./errors.js');
+
+/// <reference lib="dom" />
+// Constant for default key name
+const DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY = "ZEROXKEY_API_KEY";
+/**
+ * Stamper to use within a `ZeroXKeyClient`
+ */
+class TelegramCloudStorageStamper {
+    // the constructor checks if we're in a telegram mini app context, and then gives the developer an interface into looking into CloudStorage even without having an API key attached
+    constructor() {
+        // check to see if we're in a telegram mini app context
+        this.checkTelegramContext();
+    }
+    // create a telegram stamper by getting/setting the private/public API key values from/to telegram cloud storage
+    static async create(config) {
+        let telegramStamper = new TelegramCloudStorageStamper();
+        await telegramStamper.setSigningKey(config);
+        return telegramStamper;
+    }
+    async stamp(payload) {
+        // check to see if we're in a telegram mini app context
+        this.checkTelegramContext();
+        // check to see that the stamper was initialized
+        if (!this.stamper) {
+            throw new errors.TelegramCloudStorageStamperError("Cannot stamp with uninitialized telegram stamper, try running .create() or .setSigningKey()");
+        }
+        return await this.stamper.stamp(payload);
+    }
+    // set the API key that is used by the telegram cloud storage for signing requests
+    async setSigningKey(config) {
+        if (!config) {
+            // try to get API key at default location and set the stamper to use that
+            // passing the DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY is not necessary since getAPIKey will use that by default
+            let { apiPublicKey, apiPrivateKey } = (await this.getAPIKey(DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY)) ?? {};
+            if (apiPublicKey && apiPrivateKey) {
+                this.stamper = new apiKeyStamper.ApiKeyStamper({
+                    apiPublicKey,
+                    apiPrivateKey,
+                });
+                return;
+            }
+        }
+        else if (config.cloudStorageKey && !config.cloudStorageAPIKey) {
+            // try to get API key at specified location and set the stamper to use that
+            let { apiPublicKey, apiPrivateKey } = (await this.getAPIKey(config.cloudStorageKey)) ?? {};
+            if (apiPublicKey && apiPrivateKey) {
+                this.stamper = new apiKeyStamper.ApiKeyStamper({
+                    apiPublicKey,
+                    apiPrivateKey,
+                });
+                return;
+            }
+        }
+        else if (!config.cloudStorageKey && config.cloudStorageAPIKey) {
+            // try to set API key at default location and set the stamper to use that
+            // passing the DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY is not necessary since insertAPIKey will use that by default
+            await this.insertAPIKey(config.cloudStorageAPIKey.apiPublicKey, config.cloudStorageAPIKey.apiPrivateKey, DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY);
+            this.stamper = new apiKeyStamper.ApiKeyStamper({
+                apiPublicKey: config.cloudStorageAPIKey.apiPublicKey,
+                apiPrivateKey: config.cloudStorageAPIKey.apiPrivateKey,
+            });
+            return;
+        }
+        else if (config.cloudStorageKey && config.cloudStorageAPIKey) {
+            // try to set API key at specified location and set the stamper to use that
+            await this.insertAPIKey(config.cloudStorageAPIKey.apiPublicKey, config.cloudStorageAPIKey.apiPrivateKey, config.cloudStorageKey);
+            this.stamper = new apiKeyStamper.ApiKeyStamper({
+                apiPublicKey: config.cloudStorageAPIKey.apiPublicKey,
+                apiPrivateKey: config.cloudStorageAPIKey.apiPrivateKey,
+            });
+            return;
+        }
+        throw new errors.TelegramCloudStorageStamperError("Invalid configuration received for signing key");
+    }
+    async insertAPIKey(apiPublicKey, apiPrivateKey, key = DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY) {
+        return await this.setItem(key, this.stringifyAPIKey(apiPublicKey, apiPrivateKey));
+    }
+    async getAPIKey(key = DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY) {
+        try {
+            const apiKey = await this.getItem(key);
+            if (!apiKey) {
+                return null;
+            }
+            return this.parseAPIKey(apiKey);
+        }
+        catch {
+            return null;
+        }
+    }
+    checkTelegramContext() {
+        if (window?.Telegram?.WebApp?.CloudStorage == null) {
+            throw new errors.TelegramCloudStorageStamperError("Cannot use telegram stamper in non telegram mini-app environment, window.Telegram.WebApp.CloudStorage is not defined");
+        }
+    }
+    stringifyAPIKey(apiPublicKey, apiPrivateKey) {
+        return JSON.stringify({
+            apiPublicKey,
+            apiPrivateKey,
+        });
+    }
+    parseAPIKey(apiKey) {
+        try {
+            const parsedApiKey = JSON.parse(apiKey);
+            if (!this.isCloudStorageAPIKey(parsedApiKey)) {
+                return null;
+            }
+            return {
+                apiPublicKey: parsedApiKey.apiPublicKey,
+                apiPrivateKey: parsedApiKey.apiPrivateKey,
+            };
+        }
+        catch (err) {
+            throw new errors.TelegramCloudStorageStamperError("Failed parsing API key from Telegram Cloud Storage");
+        }
+    }
+    // determines if a passed object is of type CloudStorageAPIKey
+    isCloudStorageAPIKey(apiKey) {
+        return (typeof apiKey.apiPublicKey === "string" &&
+            typeof apiKey.apiPrivateKey === "string");
+    }
+    async getItem(key) {
+        return new Promise((resolve, reject) => {
+            window.Telegram.WebApp.CloudStorage.getItem(key, (err, value) => {
+                if (err != null) {
+                    reject(new errors.TelegramCloudStorageStamperError(`Failed getting value: ${key} from Telegram Cloud Storage${err && `: ${err}`}`));
+                }
+                resolve(value);
+            });
+        });
+    }
+    async setItem(key, value) {
+        return new Promise((resolve, reject) => {
+            window.Telegram.WebApp.CloudStorage.setItem(key, value, (err, stored) => {
+                if (err != null) {
+                    reject(new errors.TelegramCloudStorageStamperError(`Failed inserting value: ${value} into Telegram Cloud Storage at key: ${key}${err && `: ${err}`}`));
+                }
+                if (!stored) {
+                    reject(new errors.TelegramSuccessButFalseError("Telegram indicated success for storing key, but also returned false, see documention: https://core.telegram.org/bots/webapps#cloudstorage"));
+                }
+                resolve();
+            });
+        });
+    }
+    // clear key from telegram cloud storage
+    async clearItem(key) {
+        // check to see if we're in a telegram mini app context
+        this.checkTelegramContext();
+        return new Promise((resolve, reject) => {
+            window.Telegram.WebApp.CloudStorage.removeItem(key, (err, removed) => {
+                if (err) {
+                    reject(new errors.TelegramCloudStorageStamperError(`Failed removing key: ${key}${err && `: ${err}`}`));
+                }
+                if (!removed) {
+                    reject(new errors.TelegramSuccessButFalseError("Telegram indicated success for removing key, but also returned false, see documention: https://core.telegram.org/bots/webapps#cloudstorage"));
+                }
+                resolve();
+            });
+        });
+    }
+}
+
+exports.DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY = DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY;
+exports.TelegramCloudStorageStamper = TelegramCloudStorageStamper;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":["TelegramCloudStorageStamperError","ApiKeyStamper","TelegramSuccessButFalseError"],"mappings":";;;;;AAAA;AAwBA;AACO,MAAM,kCAAkC,GAAG;AAElD;;AAEG;MACU,2BAA2B,CAAA;;AAKtC,IAAA,WAAA,GAAA;;QAEE,IAAI,CAAC,oBAAoB,EAAE;IAC7B;;AAGA,IAAA,aAAa,MAAM,CAAC,MAA2C,EAAA;AAC7D,QAAA,IAAI,eAAe,GAAG,IAAI,2BAA2B,EAAE;AAEvD,QAAA,MAAM,eAAe,CAAC,aAAa,CAAC,MAAM,CAAC;AAE3C,QAAA,OAAO,eAAe;IACxB;IAEA,MAAM,KAAK,CAAC,OAAe,EAAA;;QAEzB,IAAI,CAAC,oBAAoB,EAAE;;AAG3B,QAAA,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;AACjB,YAAA,MAAM,IAAIA,uCAAgC,CACxC,6FAA6F,CAC9F;QACH;QAEA,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;IAC1C;;IAGA,MAAM,aAAa,CAAC,MAA2C,EAAA;QAC7D,IAAI,CAAC,MAAM,EAAE;;;AAGX,YAAA,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,GACjC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,kCAAkC,CAAC,KAAK,EAAE;AAElE,YAAA,IAAI,YAAY,IAAI,aAAa,EAAE;AACjC,gBAAA,IAAI,CAAC,OAAO,GAAG,IAAIC,2BAAa,CAAC;oBAC/B,YAAY;oBACZ,aAAa;AACd,iBAAA,CAAC;gBACF;YACF;QACF;aAAO,IAAI,MAAM,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE;;AAE/D,YAAA,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,GACjC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;AAEtD,YAAA,IAAI,YAAY,IAAI,aAAa,EAAE;AACjC,gBAAA,IAAI,CAAC,OAAO,GAAG,IAAIA,2BAAa,CAAC;oBAC/B,YAAY;oBACZ,aAAa;AACd,iBAAA,CAAC;gBACF;YACF;QACF;aAAO,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,kBAAkB,EAAE;;;AAG/D,YAAA,MAAM,IAAI,CAAC,YAAY,CACrB,MAAM,CAAC,kBAAkB,CAAC,YAAY,EACtC,MAAM,CAAC,kBAAkB,CAAC,aAAa,EACvC,kCAAkC,CACnC;AAED,YAAA,IAAI,CAAC,OAAO,GAAG,IAAIA,2BAAa,CAAC;AAC/B,gBAAA,YAAY,EAAE,MAAM,CAAC,kBAAkB,CAAC,YAAY;AACpD,gBAAA,aAAa,EAAE,MAAM,CAAC,kBAAkB,CAAC,aAAa;AACvD,aAAA,CAAC;YACF;QACF;aAAO,IAAI,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,kBAAkB,EAAE;;YAE9D,MAAM,IAAI,CAAC,YAAY,CACrB,MAAM,CAAC,kBAAkB,CAAC,YAAY,EACtC,MAAM,CAAC,kBAAkB,CAAC,aAAa,EACvC,MAAM,CAAC,eAAe,CACvB;AAED,YAAA,IAAI,CAAC,OAAO,GAAG,IAAIA,2BAAa,CAAC;AAC/B,gBAAA,YAAY,EAAE,MAAM,CAAC,kBAAkB,CAAC,YAAY;AACpD,gBAAA,aAAa,EAAE,MAAM,CAAC,kBAAkB,CAAC,aAAa;AACvD,aAAA,CAAC;YACF;QACF;AACA,QAAA,MAAM,IAAID,uCAAgC,CACxC,gDAAgD,CACjD;IACH;IAEA,MAAM,YAAY,CAChB,YAAoB,EACpB,aAAqB,EACrB,MAAc,kCAAkC,EAAA;AAEhD,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,GAAG,EACH,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,CAClD;IACH;AAEA,IAAA,MAAM,SAAS,CACb,GAAA,GAAc,kCAAkC,EAAA;AAEhD,QAAA,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAEtC,IAAI,CAAC,MAAM,EAAE;AACX,gBAAA,OAAO,IAAI;YACb;AAEA,YAAA,OAAO,IAAI,CAAC,WAAW,CAAC,MAAgB,CAAC;QAC3C;AAAE,QAAA,MAAM;AACN,YAAA,OAAO,IAAI;QACb;IACF;IAEA,oBAAoB,GAAA;QAClB,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,IAAI,IAAI,EAAE;AAClD,YAAA,MAAM,IAAIA,uCAAgC,CACxC,sHAAsH,CACvH;QACH;IACF;IAEA,eAAe,CAAC,YAAoB,EAAE,aAAqB,EAAA;QACzD,OAAO,IAAI,CAAC,SAAS,CAAC;YACpB,YAAY;YACZ,aAAa;AACd,SAAA,CAAC;IACJ;AAEA,IAAA,WAAW,CAAC,MAAc,EAAA;AACxB,QAAA,IAAI;YACF,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAEvC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE;AAC5C,gBAAA,OAAO,IAAI;YACb;YAEA,OAAO;gBACL,YAAY,EAAE,YAAY,CAAC,YAAY;gBACvC,aAAa,EAAE,YAAY,CAAC,aAAa;aAC1C;QACH;QAAE,OAAO,GAAG,EAAE;AACZ,YAAA,MAAM,IAAIA,uCAAgC,CACxC,oDAAoD,CACrD;QACH;IACF;;AAGA,IAAA,oBAAoB,CAAC,MAA0B,EAAA;AAC7C,QAAA,QACE,OAAO,MAAM,CAAC,YAAY,KAAK,QAAQ;AACvC,YAAA,OAAO,MAAM,CAAC,aAAa,KAAK,QAAQ;IAE5C;IAEA,MAAM,OAAO,CAAC,GAAW,EAAA;QACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;AACrC,YAAA,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CACzC,GAAG,EACH,CAAC,GAAQ,EAAE,KAAa,KAAI;AAC1B,gBAAA,IAAI,GAAG,IAAI,IAAI,EAAE;AACf,oBAAA,MAAM,CACJ,IAAIA,uCAAgC,CAClC,yBAAyB,GAAG,CAAA,4BAAA,EAC1B,GAAG,IAAI,KAAK,GAAG,CAAA,CACjB,CAAA,CAAE,CACH,CACF;gBACH;gBAEA,OAAO,CAAC,KAAK,CAAC;AAChB,YAAA,CAAC,CACF;AACH,QAAA,CAAC,CAAC;IACJ;AAEA,IAAA,MAAM,OAAO,CAAC,GAAW,EAAE,KAAa,EAAA;QACtC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;AAC3C,YAAA,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CACzC,GAAG,EACH,KAAK,EACL,CAAC,GAAQ,EAAE,MAAe,KAAI;AAC5B,gBAAA,IAAI,GAAG,IAAI,IAAI,EAAE;AACf,oBAAA,MAAM,CACJ,IAAIA,uCAAgC,CAClC,CAAA,wBAAA,EAA2B,KAAK,CAAA,qCAAA,EAAwC,GAAG,CAAA,EACzE,GAAG,IAAI,CAAA,EAAA,EAAK,GAAG,EACjB,CAAA,CAAE,CACH,CACF;gBACH;gBACA,IAAI,CAAC,MAAM,EAAE;AACX,oBAAA,MAAM,CACJ,IAAIE,mCAA4B,CAC9B,2IAA2I,CAC5I,CACF;gBACH;AAEA,gBAAA,OAAO,EAAE;AACX,YAAA,CAAC,CACF;AACH,QAAA,CAAC,CAAC;IACJ;;IAGA,MAAM,SAAS,CAAC,GAAW,EAAA;;QAEzB,IAAI,CAAC,oBAAoB,EAAE;QAE3B,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;AAC3C,YAAA,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAC5C,GAAG,EACH,CAAC,GAAQ,EAAE,OAAgB,KAAI;gBAC7B,IAAI,GAAG,EAAE;AACP,oBAAA,MAAM,CACJ,IAAIF,uCAAgC,CAClC,wBAAwB,GAAG,CAAA,EAAG,GAAG,IAAI,KAAK,GAAG,CAAA,CAAE,CAAA,CAAE,CAClD,CACF;gBACH;gBACA,IAAI,CAAC,OAAO,EAAE;AACZ,oBAAA,MAAM,CACJ,IAAIE,mCAA4B,CAC9B,4IAA4I,CAC7I,CACF;gBACH;AAEA,gBAAA,OAAO,EAAE;AACX,YAAA,CAAC,CACF;AACH,QAAA,CAAC,CAAC;IACJ;AACD;;;;;"}

package/dist/index.mjs

@@ -0,0 +1,165 @@
+import { ApiKeyStamper } from '@0xkey-io/api-key-stamper';
+import { TelegramCloudStorageStamperError, TelegramSuccessButFalseError } from './errors.mjs';
+
+/// <reference lib="dom" />
+// Constant for default key name
+const DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY = "ZEROXKEY_API_KEY";
+/**
+ * Stamper to use within a `ZeroXKeyClient`
+ */
+class TelegramCloudStorageStamper {
+    // the constructor checks if we're in a telegram mini app context, and then gives the developer an interface into looking into CloudStorage even without having an API key attached
+    constructor() {
+        // check to see if we're in a telegram mini app context
+        this.checkTelegramContext();
+    }
+    // create a telegram stamper by getting/setting the private/public API key values from/to telegram cloud storage
+    static async create(config) {
+        let telegramStamper = new TelegramCloudStorageStamper();
+        await telegramStamper.setSigningKey(config);
+        return telegramStamper;
+    }
+    async stamp(payload) {
+        // check to see if we're in a telegram mini app context
+        this.checkTelegramContext();
+        // check to see that the stamper was initialized
+        if (!this.stamper) {
+            throw new TelegramCloudStorageStamperError("Cannot stamp with uninitialized telegram stamper, try running .create() or .setSigningKey()");
+        }
+        return await this.stamper.stamp(payload);
+    }
+    // set the API key that is used by the telegram cloud storage for signing requests
+    async setSigningKey(config) {
+        if (!config) {
+            // try to get API key at default location and set the stamper to use that
+            // passing the DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY is not necessary since getAPIKey will use that by default
+            let { apiPublicKey, apiPrivateKey } = (await this.getAPIKey(DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY)) ?? {};
+            if (apiPublicKey && apiPrivateKey) {
+                this.stamper = new ApiKeyStamper({
+                    apiPublicKey,
+                    apiPrivateKey,
+                });
+                return;
+            }
+        }
+        else if (config.cloudStorageKey && !config.cloudStorageAPIKey) {
+            // try to get API key at specified location and set the stamper to use that
+            let { apiPublicKey, apiPrivateKey } = (await this.getAPIKey(config.cloudStorageKey)) ?? {};
+            if (apiPublicKey && apiPrivateKey) {
+                this.stamper = new ApiKeyStamper({
+                    apiPublicKey,
+                    apiPrivateKey,
+                });
+                return;
+            }
+        }
+        else if (!config.cloudStorageKey && config.cloudStorageAPIKey) {
+            // try to set API key at default location and set the stamper to use that
+            // passing the DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY is not necessary since insertAPIKey will use that by default
+            await this.insertAPIKey(config.cloudStorageAPIKey.apiPublicKey, config.cloudStorageAPIKey.apiPrivateKey, DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY);
+            this.stamper = new ApiKeyStamper({
+                apiPublicKey: config.cloudStorageAPIKey.apiPublicKey,
+                apiPrivateKey: config.cloudStorageAPIKey.apiPrivateKey,
+            });
+            return;
+        }
+        else if (config.cloudStorageKey && config.cloudStorageAPIKey) {
+            // try to set API key at specified location and set the stamper to use that
+            await this.insertAPIKey(config.cloudStorageAPIKey.apiPublicKey, config.cloudStorageAPIKey.apiPrivateKey, config.cloudStorageKey);
+            this.stamper = new ApiKeyStamper({
+                apiPublicKey: config.cloudStorageAPIKey.apiPublicKey,
+                apiPrivateKey: config.cloudStorageAPIKey.apiPrivateKey,
+            });
+            return;
+        }
+        throw new TelegramCloudStorageStamperError("Invalid configuration received for signing key");
+    }
+    async insertAPIKey(apiPublicKey, apiPrivateKey, key = DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY) {
+        return await this.setItem(key, this.stringifyAPIKey(apiPublicKey, apiPrivateKey));
+    }
+    async getAPIKey(key = DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY) {
+        try {
+            const apiKey = await this.getItem(key);
+            if (!apiKey) {
+                return null;
+            }
+            return this.parseAPIKey(apiKey);
+        }
+        catch {
+            return null;
+        }
+    }
+    checkTelegramContext() {
+        if (window?.Telegram?.WebApp?.CloudStorage == null) {
+            throw new TelegramCloudStorageStamperError("Cannot use telegram stamper in non telegram mini-app environment, window.Telegram.WebApp.CloudStorage is not defined");
+        }
+    }
+    stringifyAPIKey(apiPublicKey, apiPrivateKey) {
+        return JSON.stringify({
+            apiPublicKey,
+            apiPrivateKey,
+        });
+    }
+    parseAPIKey(apiKey) {
+        try {
+            const parsedApiKey = JSON.parse(apiKey);
+            if (!this.isCloudStorageAPIKey(parsedApiKey)) {
+                return null;
+            }
+            return {
+                apiPublicKey: parsedApiKey.apiPublicKey,
+                apiPrivateKey: parsedApiKey.apiPrivateKey,
+            };
+        }
+        catch (err) {
+            throw new TelegramCloudStorageStamperError("Failed parsing API key from Telegram Cloud Storage");
+        }
+    }
+    // determines if a passed object is of type CloudStorageAPIKey
+    isCloudStorageAPIKey(apiKey) {
+        return (typeof apiKey.apiPublicKey === "string" &&
+            typeof apiKey.apiPrivateKey === "string");
+    }
+    async getItem(key) {
+        return new Promise((resolve, reject) => {
+            window.Telegram.WebApp.CloudStorage.getItem(key, (err, value) => {
+                if (err != null) {
+                    reject(new TelegramCloudStorageStamperError(`Failed getting value: ${key} from Telegram Cloud Storage${err && `: ${err}`}`));
+                }
+                resolve(value);
+            });
+        });
+    }
+    async setItem(key, value) {
+        return new Promise((resolve, reject) => {
+            window.Telegram.WebApp.CloudStorage.setItem(key, value, (err, stored) => {
+                if (err != null) {
+                    reject(new TelegramCloudStorageStamperError(`Failed inserting value: ${value} into Telegram Cloud Storage at key: ${key}${err && `: ${err}`}`));
+                }
+                if (!stored) {
+                    reject(new TelegramSuccessButFalseError("Telegram indicated success for storing key, but also returned false, see documention: https://core.telegram.org/bots/webapps#cloudstorage"));
+                }
+                resolve();
+            });
+        });
+    }
+    // clear key from telegram cloud storage
+    async clearItem(key) {
+        // check to see if we're in a telegram mini app context
+        this.checkTelegramContext();
+        return new Promise((resolve, reject) => {
+            window.Telegram.WebApp.CloudStorage.removeItem(key, (err, removed) => {
+                if (err) {
+                    reject(new TelegramCloudStorageStamperError(`Failed removing key: ${key}${err && `: ${err}`}`));
+                }
+                if (!removed) {
+                    reject(new TelegramSuccessButFalseError("Telegram indicated success for removing key, but also returned false, see documention: https://core.telegram.org/bots/webapps#cloudstorage"));
+                }
+                resolve();
+            });
+        });
+    }
+}
+
+export { DEFAULT_ZEROXKEY_CLOUD_STORAGE_KEY, TelegramCloudStorageStamper };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAAA;AAwBA;AACO,MAAM,kCAAkC,GAAG;AAElD;;AAEG;MACU,2BAA2B,CAAA;;AAKtC,IAAA,WAAA,GAAA;;QAEE,IAAI,CAAC,oBAAoB,EAAE;IAC7B;;AAGA,IAAA,aAAa,MAAM,CAAC,MAA2C,EAAA;AAC7D,QAAA,IAAI,eAAe,GAAG,IAAI,2BAA2B,EAAE;AAEvD,QAAA,MAAM,eAAe,CAAC,aAAa,CAAC,MAAM,CAAC;AAE3C,QAAA,OAAO,eAAe;IACxB;IAEA,MAAM,KAAK,CAAC,OAAe,EAAA;;QAEzB,IAAI,CAAC,oBAAoB,EAAE;;AAG3B,QAAA,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;AACjB,YAAA,MAAM,IAAI,gCAAgC,CACxC,6FAA6F,CAC9F;QACH;QAEA,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;IAC1C;;IAGA,MAAM,aAAa,CAAC,MAA2C,EAAA;QAC7D,IAAI,CAAC,MAAM,EAAE;;;AAGX,YAAA,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,GACjC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,kCAAkC,CAAC,KAAK,EAAE;AAElE,YAAA,IAAI,YAAY,IAAI,aAAa,EAAE;AACjC,gBAAA,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC;oBAC/B,YAAY;oBACZ,aAAa;AACd,iBAAA,CAAC;gBACF;YACF;QACF;aAAO,IAAI,MAAM,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE;;AAE/D,YAAA,IAAI,EAAE,YAAY,EAAE,aAAa,EAAE,GACjC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;AAEtD,YAAA,IAAI,YAAY,IAAI,aAAa,EAAE;AACjC,gBAAA,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC;oBAC/B,YAAY;oBACZ,aAAa;AACd,iBAAA,CAAC;gBACF;YACF;QACF;aAAO,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,kBAAkB,EAAE;;;AAG/D,YAAA,MAAM,IAAI,CAAC,YAAY,CACrB,MAAM,CAAC,kBAAkB,CAAC,YAAY,EACtC,MAAM,CAAC,kBAAkB,CAAC,aAAa,EACvC,kCAAkC,CACnC;AAED,YAAA,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC;AAC/B,gBAAA,YAAY,EAAE,MAAM,CAAC,kBAAkB,CAAC,YAAY;AACpD,gBAAA,aAAa,EAAE,MAAM,CAAC,kBAAkB,CAAC,aAAa;AACvD,aAAA,CAAC;YACF;QACF;aAAO,IAAI,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,kBAAkB,EAAE;;YAE9D,MAAM,IAAI,CAAC,YAAY,CACrB,MAAM,CAAC,kBAAkB,CAAC,YAAY,EACtC,MAAM,CAAC,kBAAkB,CAAC,aAAa,EACvC,MAAM,CAAC,eAAe,CACvB;AAED,YAAA,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC;AAC/B,gBAAA,YAAY,EAAE,MAAM,CAAC,kBAAkB,CAAC,YAAY;AACpD,gBAAA,aAAa,EAAE,MAAM,CAAC,kBAAkB,CAAC,aAAa;AACvD,aAAA,CAAC;YACF;QACF;AACA,QAAA,MAAM,IAAI,gCAAgC,CACxC,gDAAgD,CACjD;IACH;IAEA,MAAM,YAAY,CAChB,YAAoB,EACpB,aAAqB,EACrB,MAAc,kCAAkC,EAAA;AAEhD,QAAA,OAAO,MAAM,IAAI,CAAC,OAAO,CACvB,GAAG,EACH,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,aAAa,CAAC,CAClD;IACH;AAEA,IAAA,MAAM,SAAS,CACb,GAAA,GAAc,kCAAkC,EAAA;AAEhD,QAAA,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAEtC,IAAI,CAAC,MAAM,EAAE;AACX,gBAAA,OAAO,IAAI;YACb;AAEA,YAAA,OAAO,IAAI,CAAC,WAAW,CAAC,MAAgB,CAAC;QAC3C;AAAE,QAAA,MAAM;AACN,YAAA,OAAO,IAAI;QACb;IACF;IAEA,oBAAoB,GAAA;QAClB,IAAI,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,IAAI,IAAI,EAAE;AAClD,YAAA,MAAM,IAAI,gCAAgC,CACxC,sHAAsH,CACvH;QACH;IACF;IAEA,eAAe,CAAC,YAAoB,EAAE,aAAqB,EAAA;QACzD,OAAO,IAAI,CAAC,SAAS,CAAC;YACpB,YAAY;YACZ,aAAa;AACd,SAAA,CAAC;IACJ;AAEA,IAAA,WAAW,CAAC,MAAc,EAAA;AACxB,QAAA,IAAI;YACF,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAEvC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE;AAC5C,gBAAA,OAAO,IAAI;YACb;YAEA,OAAO;gBACL,YAAY,EAAE,YAAY,CAAC,YAAY;gBACvC,aAAa,EAAE,YAAY,CAAC,aAAa;aAC1C;QACH;QAAE,OAAO,GAAG,EAAE;AACZ,YAAA,MAAM,IAAI,gCAAgC,CACxC,oDAAoD,CACrD;QACH;IACF;;AAGA,IAAA,oBAAoB,CAAC,MAA0B,EAAA;AAC7C,QAAA,QACE,OAAO,MAAM,CAAC,YAAY,KAAK,QAAQ;AACvC,YAAA,OAAO,MAAM,CAAC,aAAa,KAAK,QAAQ;IAE5C;IAEA,MAAM,OAAO,CAAC,GAAW,EAAA;QACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;AACrC,YAAA,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CACzC,GAAG,EACH,CAAC,GAAQ,EAAE,KAAa,KAAI;AAC1B,gBAAA,IAAI,GAAG,IAAI,IAAI,EAAE;AACf,oBAAA,MAAM,CACJ,IAAI,gCAAgC,CAClC,yBAAyB,GAAG,CAAA,4BAAA,EAC1B,GAAG,IAAI,KAAK,GAAG,CAAA,CACjB,CAAA,CAAE,CACH,CACF;gBACH;gBAEA,OAAO,CAAC,KAAK,CAAC;AAChB,YAAA,CAAC,CACF;AACH,QAAA,CAAC,CAAC;IACJ;AAEA,IAAA,MAAM,OAAO,CAAC,GAAW,EAAE,KAAa,EAAA;QACtC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;AAC3C,YAAA,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CACzC,GAAG,EACH,KAAK,EACL,CAAC,GAAQ,EAAE,MAAe,KAAI;AAC5B,gBAAA,IAAI,GAAG,IAAI,IAAI,EAAE;AACf,oBAAA,MAAM,CACJ,IAAI,gCAAgC,CAClC,CAAA,wBAAA,EAA2B,KAAK,CAAA,qCAAA,EAAwC,GAAG,CAAA,EACzE,GAAG,IAAI,CAAA,EAAA,EAAK,GAAG,EACjB,CAAA,CAAE,CACH,CACF;gBACH;gBACA,IAAI,CAAC,MAAM,EAAE;AACX,oBAAA,MAAM,CACJ,IAAI,4BAA4B,CAC9B,2IAA2I,CAC5I,CACF;gBACH;AAEA,gBAAA,OAAO,EAAE;AACX,YAAA,CAAC,CACF;AACH,QAAA,CAAC,CAAC;IACJ;;IAGA,MAAM,SAAS,CAAC,GAAW,EAAA;;QAEzB,IAAI,CAAC,oBAAoB,EAAE;QAE3B,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;AAC3C,YAAA,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAC5C,GAAG,EACH,CAAC,GAAQ,EAAE,OAAgB,KAAI;gBAC7B,IAAI,GAAG,EAAE;AACP,oBAAA,MAAM,CACJ,IAAI,gCAAgC,CAClC,wBAAwB,GAAG,CAAA,EAAG,GAAG,IAAI,KAAK,GAAG,CAAA,CAAE,CAAA,CAAE,CAClD,CACF;gBACH;gBACA,IAAI,CAAC,OAAO,EAAE;AACZ,oBAAA,MAAM,CACJ,IAAI,4BAA4B,CAC9B,4IAA4I,CAC7I,CACF;gBACH;AAEA,gBAAA,OAAO,EAAE;AACX,YAAA,CAAC,CACF;AACH,QAAA,CAAC,CAAC;IACJ;AACD;;;;"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@0xkey-io/telegram-cloud-storage-stamper",
+  "version": "0.1.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "description": "Telegram cloud storage stamper",
+  "keywords": [
+    "0xkey",
+    "http",
+    "stamper",
+    "telegram"
+  ],
+  "author": {
+    "name": "0xkey",
+    "url": "https://0xkey.com/"
+  },
+  "homepage": "https://github.com/0xkey-io/sdk-js/tree/main/packages/telegram-cloud-storage-stamper",
+  "bugs": {
+    "url": "https://github.com/0xkey-io/sdk-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xkey-io/sdk-js.git",
+    "directory": "packages/telegram-cloud-storage-stamper"
+  },
+  "files": [
+    "dist/",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "browser": {
+    "crypto": false
+  },
+  "dependencies": {
+    "@0xkey-io/api-key-stamper": "0.1.0"
+  },
+  "devDependencies": {
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-localstorage-mock": "^2.4.26"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "clean": "rimraf ./dist ./.cache",
+    "test": "jest",
+    "typecheck": "tsc -p tsconfig.typecheck.json"
+  }
+}