flare-plugin-sdk 0.1.0-beta.5 → 0.1.0-beta.8

package/skill/flare-plugin/assets/github-template/plugin.js

@@ -1,108 +1,114 @@
-// Adapt the illustrative website contract in README.md before publication.
-definePlugin({
-  login: {
-    token: {
-      async begin(request, context) {
-        const token = request.values.token && request.values.token.trim();
-        if (!token) fail("Validation", "Enter an access token");
-        const profile = mapProfile(await requestJson(context.origin + "/api/me", token), context);
-        return {
-          type: "success",
-          value: {
-            accountId: profile.key.id,
-            origin: context.origin,
-            credential: { accessToken: token },
-            profile,
-            capabilities: { "flare.datasource.timeline/v1": ["page"] },
-          },
-        };
-      },
-    },
-  },
-  capabilities: {
-    timeline: {
-      async page(request, context) {
-        if (request.timelineId !== "home") fail("Unsupported", "Unknown timeline");
-        const credential = await flare.credential.read();
-        if (!credential || typeof credential !== "object" || Array.isArray(credential) ||
-            typeof credential.accessToken !== "string" || !credential.accessToken) {
-          fail("AuthenticationRequired", "Import your access token again");
-        }
-        let url = context.origin + "/api/posts?limit=" + request.page.limit;
-        if (request.page.direction !== "refresh" && request.page.cursor) {
-          url += "&cursor=" + encodeURIComponent(request.page.cursor);
+"use strict";
+(() => {
+  // src/plugin.ts
+  definePlugin({
+    login: {
+      token: {
+        async begin(request, context) {
+          const token = request.values.token?.trim();
+          if (!token) fail("Validation", "Enter an access token");
+          const profile = mapProfile(await requestJson(context.origin + "/api/me", token), context);
+          return {
+            type: "success",
+            value: {
+              accountId: profile.key.id,
+              origin: context.origin,
+              credential: { accessToken: token },
+              profile,
+              capabilities: { "flare.datasource.timeline/v1": ["page"] }
+            }
+          };
         }
-        const data = await requestJson(url, credential.accessToken);
-        if (!Array.isArray(data.items)) fail("InvalidResponse", "Expected a post array");
-        if (data.next_cursor != null && (typeof data.next_cursor !== "string" || !data.next_cursor)) {
-          fail("InvalidResponse", "Expected a non-empty cursor or null");
-        }
-        return {
-          items: data.items.map(post => ({
-            key: { id: requiredString(post && post.id), host: accountHost(context) },
-            author: mapProfile(post.author, context),
-            createdAt: requiredString(post.created_at),
-            content: { format: "plain", value: requiredString(post.text) },
-            detailType: "link",
-            url: requiredString(post.url),
-          })),
-          olderCursor: data.next_cursor,
-          endReached: data.next_cursor == null,
-        };
-      },
+      }
     },
-  },
-});
-
-function accountHost(context) {
-  return context.origin.slice("https://".length);
-}
-
-function mapProfile(value, context) {
-  return {
-    key: { id: requiredString(value && value.id), host: accountHost(context) },
-    handle: requiredString(value.username),
-    displayName: requiredString(value.name),
-  };
-}
-
-function requiredString(value) {
-  if (typeof value !== "string" || !value.trim()) fail("InvalidResponse", "Missing required text field");
-  return value;
-}
-
-async function requestJson(url, token) {
-  let response;
-  try {
-    response = await flare.http.request({ url, authorization: { type: "bearer", token } });
-  } catch (error) {
-    if (error && error.code === "host.unavailable") fail("Network", "The request could not be completed");
-    throw error;
+    capabilities: {
+      timeline: {
+        async page(request, context) {
+          if (request.timelineId !== "home") fail("Unsupported", "Unknown timeline");
+          const credential = await flare.credential.read();
+          if (!credential || typeof credential !== "object" || Array.isArray(credential) || typeof credential.accessToken !== "string" || !credential.accessToken) {
+            fail("AuthenticationRequired", "Import your access token again");
+          }
+          let url = context.origin + "/api/posts?limit=" + request.page.limit;
+          if (request.page.direction !== "refresh" && request.page.cursor) {
+            url += "&cursor=" + encodeURIComponent(request.page.cursor);
+          }
+          const data = await requestJson(url, credential.accessToken);
+          if (!Array.isArray(data.items)) fail("InvalidResponse", "Expected a post array");
+          const cursor = data.next_cursor;
+          if (cursor != null && (typeof cursor !== "string" || !cursor)) {
+            fail("InvalidResponse", "Expected a non-empty cursor or null");
+          }
+          return {
+            items: data.items.map((value) => {
+              const post = requiredObject(value);
+              return {
+                key: { id: requiredString(post.id), host: accountHost(context) },
+                author: mapProfile(post.author, context),
+                createdAt: requiredString(post.created_at),
+                content: { format: "plain", value: requiredString(post.text) },
+                detailType: "link",
+                url: requiredString(post.url)
+              };
+            }),
+            olderCursor: cursor ?? void 0,
+            endReached: cursor == null
+          };
+        }
+      }
+    }
+  });
+  function accountHost(context) {
+    return context.origin.slice("https://".length);
+  }
+  function mapProfile(value, context) {
+    const profile = requiredObject(value);
+    return {
+      key: { id: requiredString(profile.id), host: accountHost(context) },
+      handle: requiredString(profile.username),
+      displayName: requiredString(profile.name)
+    };
+  }
+  function requiredString(value) {
+    if (typeof value !== "string" || !value.trim()) fail("InvalidResponse", "Missing required text field");
+    return value;
+  }
+  function requiredObject(value) {
+    if (!value || typeof value !== "object" || Array.isArray(value)) fail("InvalidResponse", "Expected a JSON object");
+    return value;
   }
-  if (response.status === 401) fail("AuthenticationRequired", "The access token was rejected");
-  if (response.status === 404) fail("NotFound", "The requested resource was not found");
-  if (response.status === 429) {
-    const entry = Object.entries(response.headers).find(([name]) => name.toLowerCase() === "retry-after");
-    const value = entry && entry[1][0];
-    const seconds = value && /^\d+$/.test(value) ? Number(value) : undefined;
-    throw flare.error({
-      code: "RateLimited",
-      message: { value: "Try again later" },
-      retryAfterSeconds: typeof seconds === "number" && Number.isInteger(seconds) && seconds <= 604800 ? seconds : undefined,
-    });
+  async function requestJson(url, token) {
+    let response;
+    try {
+      response = await flare.http.request({ url, authorization: { type: "bearer", token } });
+    } catch (error) {
+      if (error && typeof error === "object" && "code" in error && error.code === "host.unavailable") {
+        fail("Network", "The request could not be completed");
+      }
+      throw error;
+    }
+    if (response.status === 401) fail("AuthenticationRequired", "The access token was rejected");
+    if (response.status === 404) fail("NotFound", "The requested resource was not found");
+    if (response.status === 429) {
+      const entry = Object.entries(response.headers).find(([name]) => name.toLowerCase() === "retry-after");
+      const value = entry?.[1][0];
+      const seconds = value && /^\d+$/.test(value) ? Number(value) : void 0;
+      throw flare.error({
+        code: "RateLimited",
+        message: { value: "Try again later" },
+        retryAfterSeconds: typeof seconds === "number" && Number.isInteger(seconds) && seconds <= 604800 ? seconds : void 0
+      });
+    }
+    if (response.status < 200 || response.status >= 300) fail("Remote", "The website returned an error");
+    let data;
+    try {
+      data = JSON.parse(response.body);
+    } catch {
+      fail("InvalidResponse", "The website did not return JSON");
+    }
+    return requiredObject(data);
   }
-  if (response.status < 200 || response.status >= 300) fail("Remote", "The website returned an error");
-  let data;
-  try {
-    data = JSON.parse(response.body);
-  } catch (_) {
-    fail("InvalidResponse", "The website did not return JSON");
+  function fail(code, message) {
+    throw flare.error({ code, message: { value: message } });
   }
-  if (!data || typeof data !== "object" || Array.isArray(data)) fail("InvalidResponse", "Expected a JSON object");
-  return data;
-}
-
-/** @param {PluginErrorCodeV1} code @param {string} message @returns {never} */
-function fail(code, message) {
-  throw flare.error({ code, message: { value: message } });
-}
+})();

package/skill/flare-plugin/assets/github-template/src/plugin.ts

@@ -0,0 +1,118 @@
+// Adapt the illustrative website contract in README.md before publication.
+definePlugin({
+  login: {
+    token: {
+      async begin(request, context) {
+        const token = request.values.token?.trim();
+        if (!token) fail("Validation", "Enter an access token");
+        const profile = mapProfile(await requestJson(context.origin + "/api/me", token), context);
+        return {
+          type: "success",
+          value: {
+            accountId: profile.key.id,
+            origin: context.origin,
+            credential: { accessToken: token },
+            profile,
+            capabilities: { "flare.datasource.timeline/v1": ["page"] },
+          },
+        };
+      },
+    },
+  },
+  capabilities: {
+    timeline: {
+      async page(request, context) {
+        if (request.timelineId !== "home") fail("Unsupported", "Unknown timeline");
+        const credential = await flare.credential.read();
+        if (!credential || typeof credential !== "object" || Array.isArray(credential) ||
+            typeof credential.accessToken !== "string" || !credential.accessToken) {
+          fail("AuthenticationRequired", "Import your access token again");
+        }
+        let url = context.origin + "/api/posts?limit=" + request.page.limit;
+        if (request.page.direction !== "refresh" && request.page.cursor) {
+          url += "&cursor=" + encodeURIComponent(request.page.cursor);
+        }
+        const data = await requestJson(url, credential.accessToken);
+        if (!Array.isArray(data.items)) fail("InvalidResponse", "Expected a post array");
+        const cursor = data.next_cursor;
+        if (cursor != null && (typeof cursor !== "string" || !cursor)) {
+          fail("InvalidResponse", "Expected a non-empty cursor or null");
+        }
+        return {
+          items: data.items.map((value: unknown): PostV1 => {
+            const post = requiredObject(value);
+            return {
+              key: { id: requiredString(post.id), host: accountHost(context) },
+              author: mapProfile(post.author, context),
+              createdAt: requiredString(post.created_at),
+              content: { format: "plain", value: requiredString(post.text) },
+              detailType: "link",
+              url: requiredString(post.url),
+            };
+          }),
+          olderCursor: cursor ?? undefined,
+          endReached: cursor == null,
+        };
+      },
+    },
+  },
+});
+
+function accountHost(context: PluginInvocationContextV1): string {
+  return context.origin.slice("https://".length);
+}
+
+function mapProfile(value: unknown, context: PluginInvocationContextV1): ProfileV1 {
+  const profile = requiredObject(value);
+  return {
+    key: { id: requiredString(profile.id), host: accountHost(context) },
+    handle: requiredString(profile.username),
+    displayName: requiredString(profile.name),
+  };
+}
+
+function requiredString(value: unknown): string {
+  if (typeof value !== "string" || !value.trim()) fail("InvalidResponse", "Missing required text field");
+  return value;
+}
+
+function requiredObject(value: unknown): Record<string, unknown> {
+  if (!value || typeof value !== "object" || Array.isArray(value)) fail("InvalidResponse", "Expected a JSON object");
+  return value as Record<string, unknown>;
+}
+
+async function requestJson(url: string, token: string): Promise<Record<string, unknown>> {
+  let response: HttpResponseV1;
+  try {
+    response = await flare.http.request({ url, authorization: { type: "bearer", token } });
+  } catch (error) {
+    if (error && typeof error === "object" && "code" in error && error.code === "host.unavailable") {
+      fail("Network", "The request could not be completed");
+    }
+    throw error;
+  }
+  if (response.status === 401) fail("AuthenticationRequired", "The access token was rejected");
+  if (response.status === 404) fail("NotFound", "The requested resource was not found");
+  if (response.status === 429) {
+    const entry = Object.entries(response.headers).find(([name]) => name.toLowerCase() === "retry-after");
+    const value = entry?.[1][0];
+    const seconds = value && /^\d+$/.test(value) ? Number(value) : undefined;
+    throw flare.error({
+      code: "RateLimited",
+      message: { value: "Try again later" },
+      retryAfterSeconds: typeof seconds === "number" && Number.isInteger(seconds) && seconds <= 604800 ? seconds : undefined,
+    });
+  }
+  if (response.status < 200 || response.status >= 300) fail("Remote", "The website returned an error");
+  let data: unknown;
+  try {
+    data = JSON.parse(response.body);
+  } catch {
+    fail("InvalidResponse", "The website did not return JSON");
+  }
+  return requiredObject(data);
+}
+
+function fail(code: PluginErrorCodeV1, message: string): never {
+  throw flare.error({ code, message: { value: message } });
+}

package/skill/flare-plugin/assets/github-template/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "noEmit": true,
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "moduleDetection": "force",
+    "lib": ["ES2020"],
+    "types": ["flare-plugin-sdk"],
+    "isolatedModules": true
+  },
+  "include": ["src/**/*.ts"]
+}

package/skill/flare-plugin/examples/pixelfed/manifest.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://unpkg.com/flare-plugin-sdk@next/skill/flare-plugin/manifest.schema.json",
   "schemaVersion": 1,
   "apiVersion": 1,
   "id": "dev.dimension.flare.sample.pixelfed",