@design-sdk/figma-url 0.0.4 → 0.0.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Grida
+
+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/dist/index.js

@@ -11,4 +11,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./lib"), exports);
-//# sourceMappingURL=index.js.map

package/dist/lib/access-check.d.ts

@@ -0,0 +1,8 @@
+/**
+ * e.g.
+ *
+ * - **ok**: (public file) - https://www.figma.com/file/Y0Gh77AqBoHH7dG1GtK3xF/grida?node-id=1545%3A247
+ * - **not found**: (private file) - https://www.figma.com/file/8R57Uv5Siu1ZhhGkVIyyQg/private-file-api-demo?node-id=2%3A2
+ *
+ */
+export declare function isPublic(url: string): Promise<boolean>;

package/dist/lib/access-check.js

@@ -0,0 +1,39 @@
+"use strict";
+///
+/// simple functions to check if file is accessible by public.
+///
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPublic = void 0;
+const analyze_url_1 = require("./analyze-url");
+/**
+ * e.g.
+ *
+ * - **ok**: (public file) - https://www.figma.com/file/Y0Gh77AqBoHH7dG1GtK3xF/grida?node-id=1545%3A247
+ * - **not found**: (private file) - https://www.figma.com/file/8R57Uv5Siu1ZhhGkVIyyQg/private-file-api-demo?node-id=2%3A2
+ *
+ */
+function isPublic(url) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const type = (0, analyze_url_1.analyze)(url);
+        if (type == analyze_url_1.FigmaUrlType.embed || analyze_url_1.FigmaUrlType.file || analyze_url_1.FigmaUrlType.node) {
+            try {
+                const res = yield fetch(url);
+                return res.status == 200;
+            }
+            catch (e) {
+                return false;
+            }
+        }
+        return false;
+    });
+}
+exports.isPublic = isPublic;

package/dist/lib/analyze-url.d.ts

@@ -16,4 +16,11 @@ export declare enum FigmaUrlType {
      */
     empty = "empty"
 }
-export declare function analyze(url: string): FigmaUrlType;
+export declare enum FigmaFileOrNodeIdType {
+    nodeid = "nodeid",
+    maybe_nodeid = "maybe_nodeid",
+    fileid = "fileid",
+    maybe_fileid = "maybe_fileid"
+}
+export declare type FigmaInputAnalysisResult = FigmaUrlType | FigmaFileOrNodeIdType;
+export declare function analyze(url: string): FigmaInputAnalysisResult;

package/dist/lib/analyze-url.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.analyze = exports.FigmaUrlType = void 0;
+exports.analyze = exports.FigmaFileOrNodeIdType = exports.FigmaUrlType = void 0;
 const constants_1 = require("./constants");
 var FigmaUrlType;
 (function (FigmaUrlType) {
@@ -21,6 +21,13 @@ var FigmaUrlType;
      */
     FigmaUrlType["empty"] = "empty";
 })(FigmaUrlType = exports.FigmaUrlType || (exports.FigmaUrlType = {}));
+var FigmaFileOrNodeIdType;
+(function (FigmaFileOrNodeIdType) {
+    FigmaFileOrNodeIdType["nodeid"] = "nodeid";
+    FigmaFileOrNodeIdType["maybe_nodeid"] = "maybe_nodeid";
+    FigmaFileOrNodeIdType["fileid"] = "fileid";
+    FigmaFileOrNodeIdType["maybe_fileid"] = "maybe_fileid";
+})(FigmaFileOrNodeIdType = exports.FigmaFileOrNodeIdType || (exports.FigmaFileOrNodeIdType = {}));
 function analyze(url) {
     var _a;
     if (!url) {
@@ -33,6 +40,36 @@ function analyze(url) {
         _u = new URL(url);
     }
     catch (_) {
+        const maybeidlike = url;
+        if (maybeidlike.length > 0) {
+            if (maybeidlike.includes(":") || maybeidlike.includes("%3A")) {
+                let _target = maybeidlike;
+                // "%3A" is ":" as in url encoding
+                if (_target.includes("%3A")) {
+                    // decode value, assuming it is url encoded
+                    _target = decodeURI(_target);
+                }
+                // 2. run regex
+                if (_target.match(/[0-9]+:[0-9]+/) !== null) {
+                    return FigmaFileOrNodeIdType.maybe_nodeid;
+                }
+            }
+            // e.g. kLzb7R9xYuuphfX4TssVNe
+            // e.g. 4hqwYFw6FKw1njvzEl3VUh
+            // fileid is 22 chars at this point.
+            else if (maybeidlike.length >= 22) {
+                const _taget = decodeURI(maybeidlike);
+                // figma file id does not contain special characters. it's like mongodb id
+                if (_taget.match(/[a-zA-Z0-9]/) !== null) {
+                    if (_taget.length == 22) {
+                        return FigmaFileOrNodeIdType.fileid;
+                    }
+                    else {
+                        return FigmaFileOrNodeIdType.maybe_fileid;
+                    }
+                }
+            }
+        }
         throw `this url cannot be analyzed. this is not a valid url string - "${url}"`;
     }
     //
@@ -60,4 +97,3 @@ function analyze(url) {
     }
 }
 exports.analyze = analyze;
-//# sourceMappingURL=analyze-url.js.map

package/dist/lib/compare-url.d.ts

@@ -0,0 +1 @@
+export declare function isSameDesignUrl(url1: string, url2: string): boolean;

package/dist/lib/compare-url.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSameDesignUrl = void 0;
+const analyze_url_1 = require("./analyze-url");
+const parse_url_1 = require("./parse-url");
+function isSameDesignUrl(url1, url2) {
+    const analysis = (0, analyze_url_1.analyze)(url1);
+    switch (analysis) {
+        case analyze_url_1.FigmaUrlType.embed:
+        case analyze_url_1.FigmaUrlType.empty:
+        case analyze_url_1.FigmaUrlType.file:
+            return false;
+        case analyze_url_1.FigmaUrlType.node:
+            const parsed = (0, parse_url_1.parseFileAndNodeId)(url1);
+            const _this_parsed = (0, parse_url_1.parseFileAndNodeId)(url2);
+            return (_this_parsed.file === parsed.file && _this_parsed.node === parsed.node);
+    }
+}
+exports.isSameDesignUrl = isSameDesignUrl;

package/dist/lib/constants.js

@@ -28,4 +28,3 @@ exports.__FIGMA_DEMO_DEFAULT_FILE_ID = "Y0Gh77AqBoHH7dG1GtK3xF";
 exports.__FIGMA_DEMO_DEFAULT_FILE_URL = "https://www.figma.com/file/Y0Gh77AqBoHH7dG1GtK3xF/";
 exports.__FIGMA_DEMO_DEFAULT_FILE_NODE_URL = "https://www.figma.com/file/Y0Gh77AqBoHH7dG1GtK3xF/?node-id=264%3A49";
 // ======================================================================================================
-//# sourceMappingURL=constants.js.map

package/dist/lib/embed-url.js

@@ -10,7 +10,7 @@ const constants_1 = require("./constants");
  */
 function embed(src) {
     const url = builEmbedableSourceUrl(src);
-    const urltype = analyze_url_1.analyze(url);
+    const urltype = (0, analyze_url_1.analyze)(url);
     switch (urltype) {
         case analyze_url_1.FigmaUrlType.embed:
             return url;
@@ -19,6 +19,8 @@ function embed(src) {
             return _build(url);
         case analyze_url_1.FigmaUrlType.node:
             return _build(url);
+        case analyze_url_1.FigmaUrlType.empty:
+            return;
     }
 }
 exports.embed = embed;
@@ -52,4 +54,3 @@ function builEmbedableSourceUrl(src) {
     }
 }
 exports.builEmbedableSourceUrl = builEmbedableSourceUrl;
-//# sourceMappingURL=embed-url.js.map

package/dist/lib/index.d.ts

@@ -1,5 +1,7 @@
 export * from "./embed-url";
 export * from "./parse-url";
+export * from "./access-check";
 export * from "./analyze-url";
 export * from "./target-node-config";
 export * from "./constants";
+export * from "./compare-url";

package/dist/lib/index.js

@@ -12,7 +12,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./embed-url"), exports);
 __exportStar(require("./parse-url"), exports);
+__exportStar(require("./access-check"), exports);
 __exportStar(require("./analyze-url"), exports);
 __exportStar(require("./target-node-config"), exports);
 __exportStar(require("./constants"), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require("./compare-url"), exports);

package/dist/lib/parse-url.js

@@ -42,4 +42,3 @@ function parseFileAndNodeId(url) {
     }
 }
 exports.parseFileAndNodeId = parseFileAndNodeId;
-//# sourceMappingURL=parse-url.js.map

package/dist/lib/target-node-config.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=target-node-config.js.map

package/package.json

@@ -1,13 +1,18 @@
 {
     "name": "@design-sdk/figma-url",
-    "version": "0.0.4",
+    "version": "0.0.8",
     "description": "Figma url utils for sharing & embeding and url inspection",
     "license": "MIT",
-    "main": "dist/index.js",
+    "private": false,
     "homepage": "https://github.com/gridaco/design-sdk",
     "repository": "https://github.com/gridaco/design-sdk",
+    "authors": [
+        "grida.co",
+        "softmarshmallow <universe@grida.co>"
+    ],
     "scripts": {
-        "prepack": "yarn test && tsc",
+        "clean": "rimraf dist",
+        "build": "yarn clean && tsc",
         "test": "jest"
     },
     "files": [
@@ -20,5 +25,6 @@
     ],
     "publishConfig": {
         "access": "public"
-    }
-}
+    },
+    "gitHead": "e0abc41876d7c290b3dc1a9b355e5e9e7aa0c332"
+}