@ailuracode/alpine-share 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) ailuracode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# @ailuracode/alpine-share
+
+Web Share API magic for Alpine.js.
+
+**[Full documentation →](../../docs/share.md)**
+
+## Install
+
+```bash
+npm install @ailuracode/alpine-share alpinejs
+```
+
+## Quick example
+
+```js
+import Alpine from "alpinejs";
+import share from "@ailuracode/alpine-share";
+
+Alpine.plugin(share);
+Alpine.start();
+```
+
+```html
+<button
+  x-show="$share.isSupported()"
+  @click="await $share({ title: 'Hello', url: window.location.href })"
+>
+  Share page
+</button>
+```
+
+## API summary
+
+| | |
+|-|-|
+| **Magic** | `$share(data)` |
+| **Helpers** | `$share.isSupported()`, `$share.canShare(data?)` |
+
+Callable like `$clipboard`.
+
+## License
+
+MIT

package/dist/global.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="@types/alpinejs" />
+
+export type { ShareMagic } from "./index.js";
+
+declare global {
+  namespace Alpine {
+    interface Magics<T> {
+      $share: import("./index.js").ShareMagic;
+    }
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import AlpineType from 'alpinejs';
+
+type ShareMagic = ((data: ShareData) => Promise<boolean>) & {
+    isSupported(): boolean;
+    canShare(data?: ShareData): boolean;
+};
+/** Returns whether the Web Share API is available in this environment. */
+declare function isShareSupported(): boolean;
+/** Returns whether the given payload can be shared, or whether sharing is available when omitted. */
+declare function canShareData(data?: ShareData): boolean;
+/** Invokes `navigator.share` and resolves to `true` on success. Never throws. */
+declare function shareData(data: ShareData): Promise<boolean>;
+/** Builds callable `$share` magic with `isSupported` and `canShare` helpers. */
+declare function createShareMagic(): ShareMagic;
+/** Alpine.js share plugin. Registers callable magic `$share`. */
+declare function sharePlugin(Alpine: AlpineType.Alpine): void;
+declare global {
+    namespace Alpine {
+        interface Magics<T> {
+            $share: ShareMagic;
+        }
+    }
+}
+
+export { type ShareMagic, canShareData, createShareMagic, sharePlugin as default, isShareSupported, shareData };

package/dist/index.js

@@ -0,0 +1,57 @@
+// src/index.ts
+function isSecureContext() {
+  return typeof globalThis !== "undefined" && globalThis.isSecureContext === true;
+}
+function hasShareApi() {
+  return typeof navigator !== "undefined" && typeof navigator.share === "function";
+}
+function isShareSupported() {
+  return isSecureContext() && hasShareApi();
+}
+function canShareData(data) {
+  if (!isShareSupported()) {
+    return false;
+  }
+  if (data === void 0) {
+    return true;
+  }
+  if (typeof navigator.canShare === "function") {
+    try {
+      return navigator.canShare(data);
+    } catch {
+      return false;
+    }
+  }
+  if (data.files?.length) {
+    return false;
+  }
+  return Boolean(data.title || data.text || data.url);
+}
+async function shareData(data) {
+  if (!canShareData(data)) {
+    return false;
+  }
+  try {
+    await navigator.share(data);
+    return true;
+  } catch {
+    return false;
+  }
+}
+function createShareMagic() {
+  const share = (data) => shareData(data);
+  share.isSupported = isShareSupported;
+  share.canShare = canShareData;
+  return share;
+}
+function sharePlugin(Alpine) {
+  Alpine.magic("share", () => createShareMagic());
+}
+export {
+  canShareData,
+  createShareMagic,
+  sharePlugin as default,
+  isShareSupported,
+  shareData
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type AlpineType from \"alpinejs\";\n\nexport type ShareMagic = ((data: ShareData) => Promise<boolean>) & {\n  isSupported(): boolean;\n  canShare(data?: ShareData): boolean;\n};\n\nfunction isSecureContext(): boolean {\n  return typeof globalThis !== \"undefined\" && globalThis.isSecureContext === true;\n}\n\nfunction hasShareApi(): boolean {\n  return typeof navigator !== \"undefined\" && typeof navigator.share === \"function\";\n}\n\n/** Returns whether the Web Share API is available in this environment. */\nexport function isShareSupported(): boolean {\n  return isSecureContext() && hasShareApi();\n}\n\n/** Returns whether the given payload can be shared, or whether sharing is available when omitted. */\nexport function canShareData(data?: ShareData): boolean {\n  if (!isShareSupported()) {\n    return false;\n  }\n\n  if (data === undefined) {\n    return true;\n  }\n\n  if (typeof navigator.canShare === \"function\") {\n    try {\n      return navigator.canShare(data);\n    } catch {\n      return false;\n    }\n  }\n\n  if (data.files?.length) {\n    return false;\n  }\n\n  return Boolean(data.title || data.text || data.url);\n}\n\n/** Invokes `navigator.share` and resolves to `true` on success. Never throws. */\nexport async function shareData(data: ShareData): Promise<boolean> {\n  if (!canShareData(data)) {\n    return false;\n  }\n\n  try {\n    await navigator.share(data);\n    return true;\n  } catch {\n    return false;\n  }\n}\n\n/** Builds callable `$share` magic with `isSupported` and `canShare` helpers. */\nexport function createShareMagic(): ShareMagic {\n  const share = (data: ShareData) => shareData(data);\n  share.isSupported = isShareSupported;\n  share.canShare = canShareData;\n  return share;\n}\n\n/** Alpine.js share plugin. Registers callable magic `$share`. */\nexport default function sharePlugin(Alpine: AlpineType.Alpine): void {\n  Alpine.magic(\"share\", () => createShareMagic());\n}\n\ndeclare global {\n  namespace Alpine {\n    interface Magics<T> {\n      $share: ShareMagic;\n    }\n  }\n}\n"],"mappings":";AAOA,SAAS,kBAA2B;AAClC,SAAO,OAAO,eAAe,eAAe,WAAW,oBAAoB;AAC7E;AAEA,SAAS,cAAuB;AAC9B,SAAO,OAAO,cAAc,eAAe,OAAO,UAAU,UAAU;AACxE;AAGO,SAAS,mBAA4B;AAC1C,SAAO,gBAAgB,KAAK,YAAY;AAC1C;AAGO,SAAS,aAAa,MAA2B;AACtD,MAAI,CAAC,iBAAiB,GAAG;AACvB,WAAO;AAAA,EACT;AAEA,MAAI,SAAS,QAAW;AACtB,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,UAAU,aAAa,YAAY;AAC5C,QAAI;AACF,aAAO,UAAU,SAAS,IAAI;AAAA,IAChC,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAEA,MAAI,KAAK,OAAO,QAAQ;AACtB,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,KAAK,SAAS,KAAK,QAAQ,KAAK,GAAG;AACpD;AAGA,eAAsB,UAAU,MAAmC;AACjE,MAAI,CAAC,aAAa,IAAI,GAAG;AACvB,WAAO;AAAA,EACT;AAEA,MAAI;AACF,UAAM,UAAU,MAAM,IAAI;AAC1B,WAAO;AAAA,EACT,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAGO,SAAS,mBAA+B;AAC7C,QAAM,QAAQ,CAAC,SAAoB,UAAU,IAAI;AACjD,QAAM,cAAc;AACpB,QAAM,WAAW;AACjB,SAAO;AACT;AAGe,SAAR,YAA6B,QAAiC;AACnE,SAAO,MAAM,SAAS,MAAM,iBAAiB,CAAC;AAChD;","names":[]}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@ailuracode/alpine-share",
+  "version": "0.2.0",
+  "description": "Alpine.js Web Share API magic",
+  "type": "module",
+  "license": "MIT",
+  "author": "ailuracode",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ailuracode/alpine.git",
+    "directory": "packages/share"
+  },
+  "bugs": {
+    "url": "https://github.com/ailuracode/alpine/issues"
+  },
+  "homepage": "https://github.com/ailuracode/alpine/tree/master/packages/share#readme",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./global": {
+      "types": "./dist/global.d.ts"
+    }
+  },
+  "types": "./dist/global.d.ts",
+  "peerDependencies": {
+    "alpinejs": "^3.0.0",
+    "@types/alpinejs": "^3.13.11"
+  },
+  "peerDependenciesMeta": {
+    "@types/alpinejs": {
+      "optional": true
+    }
+  },
+  "keywords": [
+    "alpinejs",
+    "alpine",
+    "plugin",
+    "share",
+    "web-share-api"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --sourcemap --out-dir dist && cp src/global.d.ts dist/global.d.ts",
+    "test": "vitest run --config ../../vitest.config.js test"
+  }
+}