@quick-launch-url/shared 0.0.1 → 0.0.2

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 (4) hide show
  1. package/README.md +64 -30
  2. package/dist/index.js +1 -1
  3. package/dist/types/index.d.ts +1 -0
  4. package/package.json +16 -2
package/README.md CHANGED
@@ -1,24 +1,67 @@
1
- # Shared
1
+ <p align="center">
2
+ <a href="https://zhensherlock.github.io/quick-launch-url/" target="_blank" rel="noopener noreferrer">
3
+ <img width="300" src="https://zhensherlock.github.io/quick-launch-url/logo.svg" alt="watermark logo">
4
+ </a>
5
+ </p>
2
6
 
3
- <div align="center">
7
+ # Quick Launch URL
4
8
 
5
- [//]: # ([![][npm-release-shield]][npm-release-link])
9
+ One-click launch URL generator for protocol-based apps.
6
10
 
7
- [//]: # ([![][npm-downloads-shield]][npm-downloads-link])
11
+ [![][npm-release-shield]][npm-release-link]
12
+ [![][codecov-shield]][codecov-link]
13
+ [![][github-release-date-shield]][github-release-date-link]
14
+ [![][github-action-build-shield]][github-action-build-link]
15
+ [![][github-license-shield]][github-license-link]
8
16
 
9
- [//]: # ([![][package-size-shield]][package-size-link])
17
+ ## Features
10
18
 
11
- [//]: # ([![][codecov-shield]][codecov-link] <br/>)
19
+ - 🛡️️ Type-Safe
20
+ - 🌍 Multi-App Ready
21
+ - 🌿 On-Demand / Tree-shakable
22
+ - 🔐 Secure Encoding
23
+ - ⚙️ Zero Runtime Dependencies
24
+ - 📦 ESM First
12
25
 
13
- [//]: # ([![][github-release-date-shield]][github-release-date-link])
26
+ ## Installation
14
27
 
15
- [//]: # ([![][github-action-build-shield]][github-action-build-link])
28
+ ```bash
29
+ npm install @quick-launch-url/core
30
+ ```
16
31
 
17
- [//]: # ([![][github-license-shield]][github-license-link])
32
+ or
18
33
 
19
- [//]: # ([![][gitter-shield]][gitter-link])
34
+ ```bash
35
+ yarn install @quick-launch-url/core
36
+ ```
20
37
 
21
- </div>
38
+ or
39
+
40
+ ```bash
41
+ pnpm install @quick-launch-url/core
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ ### On-Demand Import (Recommended)
47
+
48
+ ```ts
49
+ // Cherry Studio
50
+ import { installMCP, installProvider } from '@quick-launch-url/core/cherry-studio'
51
+
52
+ // Cursor
53
+ import { installMCP as installCursorMCP } from '@quick-launch-url/core/cursor'
54
+ ```
55
+
56
+ ### Full Import
57
+
58
+ ```ts
59
+ import { cherryStudio, cursor } from '@quick-launch-url/core'
60
+ ```
61
+
62
+ ## Docs
63
+
64
+ Full guides and examples: https://zhensherlock.github.io/quick-launch-url/
22
65
 
23
66
  ## Contributing
24
67
 
@@ -38,22 +81,13 @@ This project exists thanks to all the people who contribute.
38
81
 
39
82
  [MIT](LICENSE) © MichaelSun
40
83
 
41
- [//]: # ([npm-release-link]: https://www.npmjs.com/package/quick-launch-url)
42
-
43
- [//]: # ([npm-release-shield]: https://img.shields.io/npm/v/quick-launch-url?color=1677FF&labelColor=black&logo=npm&logoColor=white&style=flat-square)
44
-
45
- [//]: # ([codecov-link]: https://coveralls.io/github/zhensherlock/quick-launch-url?branch=main)
46
-
47
- [//]: # ([codecov-shield]: https://img.shields.io/coverallsCoverage/github/zhensherlock/quick-launch-url?color=1677FF&labelColor=black&style=flat-square&logo=codecov&logoColor=white)
48
-
49
- [//]: # ([github-release-date-link]: https://github.com/zhensherlock/quick-launch-url/releases)
50
-
51
- [//]: # ([github-release-date-shield]: https://img.shields.io/github/release-date/zhensherlock/quick-launch-url?color=1677FF&labelColor=black&style=flat-square)
52
-
53
- [//]: # ([github-action-build-link]: https://github.com/zhensherlock/quick-launch-url/actions/workflows/build.yml)
54
-
55
- [//]: # ([github-action-build-shield]: https://img.shields.io/github/actions/workflow/status/zhensherlock/quick-launch-url/build.yml?branch=main&color=1677FF&label=build&labelColor=black&logo=githubactions&logoColor=white&style=flat-square)
56
-
57
- [//]: # ([github-license-link]: https://github.com/zhensherlock/quick-launch-url/blob/main/LICENSE)
58
-
59
- [//]: # ([github-license-shield]: https://img.shields.io/github/license/zhensherlock/quick-launch-url?color=1677FF&labelColor=black&style=flat-square)
84
+ [npm-release-link]: https://www.npmjs.com/package/@quick-launch-url/core
85
+ [npm-release-shield]: https://img.shields.io/npm/v/@quick-launch-url/core?color=1677FF&labelColor=black&logo=npm&logoColor=white&style=flat-square
86
+ [codecov-link]: https://coveralls.io/github/zhensherlock/quick-launch-url?branch=main
87
+ [codecov-shield]: https://img.shields.io/coverallsCoverage/github/zhensherlock/quick-launch-url?color=1677FF&labelColor=black&style=flat-square&logo=codecov&logoColor=white
88
+ [github-release-date-link]: https://github.com/zhensherlock/quick-launch-url/releases
89
+ [github-release-date-shield]: https://img.shields.io/github/release-date/zhensherlock/quick-launch-url?color=1677FF&labelColor=black&style=flat-square
90
+ [github-action-build-link]: https://github.com/zhensherlock/quick-launch-url/actions/workflows/build.yml
91
+ [github-action-build-shield]: https://img.shields.io/github/actions/workflow/status/zhensherlock/quick-launch-url/build.yml?branch=main&color=1677FF&label=build&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
92
+ [github-license-link]: https://github.com/zhensherlock/quick-launch-url/blob/main/LICENSE
93
+ [github-license-shield]: https://img.shields.io/github/license/zhensherlock/quick-launch-url?color=1677FF&labelColor=black&style=flat-square
package/dist/index.js CHANGED
@@ -1 +1 @@
1
- function e(e){return btoa(encodeURIComponent(e).replace(/%([0-9A-F]{2})/g,(e,n)=>String.fromCharCode(parseInt(n,16))))}function n(n,t={}){const{useSafeEncoding:o=!1}=t,r=JSON.stringify(n);let c;if(o)c=e(r);else try{c=btoa(r)}catch{c=e(r)}return encodeURIComponent(c)}export{n as encodeUrlPayload};
1
+ function n(n){return void 0===n}function e(n){return btoa(encodeURIComponent(n).replace(/%([0-9A-F]{2})/g,(n,e)=>String.fromCharCode(parseInt(e,16))))}function t(n,t={}){const{useSafeEncoding:o=!1}=t,r=JSON.stringify(n);let c;if(o)c=e(r);else try{c=btoa(r)}catch{c=e(r)}return encodeURIComponent(c)}export{t as encodeUrlPayload,n as isUndefined};
package/dist/types/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export interface EncodeOptions {
2
2
  useSafeEncoding?: boolean;
3
3
  }
4
+ export declare function isUndefined(value: unknown): value is undefined;
4
5
  export declare function encodeUrlPayload(payload: unknown, options?: EncodeOptions): string;
package/package.json CHANGED
@@ -1,13 +1,27 @@
1
1
  {
2
2
  "name": "@quick-launch-url/shared",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "One-click launch URL generator for protocol-based apps.",
5
5
  "type": "module",
6
6
  "author": "zhensherlock",
7
- "homepage": "https://github.com/zhensherlock/quick-launch-url/tree/master/packages/shared#readme",
7
+ "homepage": "https://zhensherlock.github.io/quick-launch-url",
8
8
  "keywords": [
9
9
  "quick-launch",
10
10
  "quick-launch-url",
11
+ "deep-link",
12
+ "deeplink",
13
+ "url-scheme",
14
+ "protocol",
15
+ "mcp",
16
+ "modelcontextprotocol",
17
+ "cursor",
18
+ "cherry-studio",
19
+ "provider",
20
+ "api-key",
21
+ "install",
22
+ "one-click",
23
+ "tree-shaking",
24
+ "esm",
11
25
  "typescript"
12
26
  ],
13
27
  "main": "dist/index.js",