@plasmicpkgs/plasmic-strapi 0.1.123 → 0.1.125

package/dist/index.d.mts

@@ -0,0 +1,45 @@
+import registerComponent from '@plasmicapp/host/registerComponent';
+import registerGlobalContext from '@plasmicapp/host/registerGlobalContext';
+import { GlobalContextMeta, ComponentMeta } from '@plasmicapp/host';
+import React, { ReactNode } from 'react';
+
+declare function ensure<T>(x: T | null | undefined): T;
+interface StrapiCredentialsProviderProps {
+    host?: string;
+    token?: string;
+}
+declare const strapiCredentialsProviderMeta: GlobalContextMeta<StrapiCredentialsProviderProps>;
+declare function StrapiCredentialsProvider({ host, token, children, }: React.PropsWithChildren<StrapiCredentialsProviderProps>): React.JSX.Element;
+interface StrapiCollectionProps {
+    name?: string;
+    children?: ReactNode;
+    className?: string;
+    noLayout?: boolean;
+    noAutoRepeat?: boolean;
+    filterField?: string;
+    filterValue?: string;
+    limit?: number;
+    filterParameter?: string;
+    setControlContextData?: (data: {
+        strapiFields: string[];
+    }) => void;
+}
+declare const strapiCollectionMeta: ComponentMeta<StrapiCollectionProps>;
+declare function StrapiCollection({ name, filterParameter, filterValue, filterField, limit, children, className, noLayout, noAutoRepeat, setControlContextData, }: StrapiCollectionProps): React.JSX.Element;
+interface StrapiFieldProps {
+    className?: string;
+    path?: string;
+    setControlContextData?: (data: {
+        fields: string[];
+        isImage: boolean;
+    }) => void;
+}
+declare const strapiFieldMeta: ComponentMeta<StrapiFieldProps>;
+declare function StrapiField({ className, path, setControlContextData, }: StrapiFieldProps): React.JSX.Element;
+
+declare function registerAll(loader?: {
+    registerComponent: typeof registerComponent;
+    registerGlobalContext: typeof registerGlobalContext;
+}): void;
+
+export { StrapiCollection, StrapiCredentialsProvider, StrapiField, ensure, registerAll, strapiCollectionMeta, strapiCredentialsProviderMeta, strapiFieldMeta };

package/dist/index.d.ts

@@ -1,7 +1,45 @@
-import registerComponent from "@plasmicapp/host/registerComponent";
-import registerGlobalContext from "@plasmicapp/host/registerGlobalContext";
-export declare function registerAll(loader?: {
-    registerComponent: typeof registerComponent;
-    registerGlobalContext: typeof registerGlobalContext;
-}): void;
-export * from "./strapi";
+import registerComponent from '@plasmicapp/host/registerComponent';
+import registerGlobalContext from '@plasmicapp/host/registerGlobalContext';
+import { GlobalContextMeta, ComponentMeta } from '@plasmicapp/host';
+import React, { ReactNode } from 'react';
+
+declare function ensure<T>(x: T | null | undefined): T;
+interface StrapiCredentialsProviderProps {
+    host?: string;
+    token?: string;
+}
+declare const strapiCredentialsProviderMeta: GlobalContextMeta<StrapiCredentialsProviderProps>;
+declare function StrapiCredentialsProvider({ host, token, children, }: React.PropsWithChildren<StrapiCredentialsProviderProps>): React.JSX.Element;
+interface StrapiCollectionProps {
+    name?: string;
+    children?: ReactNode;
+    className?: string;
+    noLayout?: boolean;
+    noAutoRepeat?: boolean;
+    filterField?: string;
+    filterValue?: string;
+    limit?: number;
+    filterParameter?: string;
+    setControlContextData?: (data: {
+        strapiFields: string[];
+    }) => void;
+}
+declare const strapiCollectionMeta: ComponentMeta<StrapiCollectionProps>;
+declare function StrapiCollection({ name, filterParameter, filterValue, filterField, limit, children, className, noLayout, noAutoRepeat, setControlContextData, }: StrapiCollectionProps): React.JSX.Element;
+interface StrapiFieldProps {
+    className?: string;
+    path?: string;
+    setControlContextData?: (data: {
+        fields: string[];
+        isImage: boolean;
+    }) => void;
+}
+declare const strapiFieldMeta: ComponentMeta<StrapiFieldProps>;
+declare function StrapiField({ className, path, setControlContextData, }: StrapiFieldProps): React.JSX.Element;
+
+declare function registerAll(loader?: {
+    registerComponent: typeof registerComponent;
+    registerGlobalContext: typeof registerGlobalContext;
+}): void;
+
+export { StrapiCollection, StrapiCredentialsProvider, StrapiField, ensure, registerAll, strapiCollectionMeta, strapiCredentialsProviderMeta, strapiFieldMeta };

package/dist/index.js

@@ -1,8 +1,417 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-'use strict'
+// src/index.tsx
+var src_exports = {};
+__export(src_exports, {
+  StrapiCollection: () => StrapiCollection,
+  StrapiCredentialsProvider: () => StrapiCredentialsProvider,
+  StrapiField: () => StrapiField,
+  ensure: () => ensure,
+  registerAll: () => registerAll,
+  strapiCollectionMeta: () => strapiCollectionMeta,
+  strapiCredentialsProviderMeta: () => strapiCredentialsProviderMeta,
+  strapiFieldMeta: () => strapiFieldMeta
+});
+module.exports = __toCommonJS(src_exports);
+var import_registerComponent = __toESM(require("@plasmicapp/host/registerComponent"));
+var import_registerGlobalContext = __toESM(require("@plasmicapp/host/registerGlobalContext"));
 
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./plasmic-strapi.cjs.production.min.js')
-} else {
-  module.exports = require('./plasmic-strapi.cjs.development.js')
+// src/strapi.tsx
+var import_host = require("@plasmicapp/host");
+var import_query = require("@plasmicapp/query");
+var qs = __toESM(require("qs"));
+var import_dlv = __toESM(require("dlv"));
+var import_change_case = require("change-case");
+var import_react = __toESM(require("react"));
+
+// src/utils.ts
+var queryParameters = [
+  {
+    value: "$eq",
+    label: "Equal"
+  },
+  {
+    value: "$ne",
+    label: "Not equal"
+  },
+  {
+    value: "$lt",
+    label: "Less than"
+  },
+  {
+    value: "$lte",
+    label: "Less than or equal to"
+  },
+  {
+    value: "$gt",
+    label: "Greater than"
+  },
+  {
+    value: "$gte",
+    label: "Greater than or equal to"
+  },
+  {
+    value: "$in",
+    label: "Included in an array"
+  },
+  {
+    value: "$notIn",
+    label: "Not included in an array"
+  },
+  {
+    value: "$contains",
+    label: "Contains"
+  },
+  {
+    value: "$notContains",
+    label: "Does not contain"
+  }
+];
+var uniq = (xs) => Array.from(new Set(xs));
+
+// src/strapi.tsx
+function ensure(x) {
+  if (x === null || x === void 0) {
+    throw new Error(`Value must not be undefined or null`);
+  } else {
+    return x;
+  }
+}
+var modulePath = "@plasmicpkgs/plasmic-strapi";
+var makeDataProviderName = (collection) => `currentStrapi${(0, import_change_case.pascalCase)(collection)}Item`;
+var CredentialsContext = import_react.default.createContext(void 0);
+var strapiCredentialsProviderMeta = {
+  name: "StrapiCredentialsProvider",
+  displayName: "Strapi Credentials Provider",
+  description: `[See tutorial video](https://www.youtube.com/watch?v=1SLoVY3hkQ4).
+
+API token is needed only if data is not publicly readable.
+
+Learn how to [get your API token](https://docs.strapi.io/user-docs/latest/settings/managing-global-settings.html#managing-api-tokens).`,
+  importName: "StrapiCredentialsProvider",
+  importPath: modulePath,
+  props: {
+    host: {
+      type: "string",
+      displayName: "Host",
+      defaultValueHint: "https://strapi-app.plasmic.app",
+      defaultValue: "https://strapi-app.plasmic.app",
+      description: "Server where you application is hosted."
+    },
+    token: {
+      type: "string",
+      displayName: "API Token",
+      description: "API Token (generated in http://yourhost/admin/settings/api-tokens) (or leave blank for unauthenticated usage)."
+    }
+  }
+};
+function StrapiCredentialsProvider({
+  host,
+  token,
+  children
+}) {
+  host = (host == null ? void 0 : host.slice(-1)) === "/" ? host.slice(0, -1) : host;
+  return /* @__PURE__ */ import_react.default.createElement(CredentialsContext.Provider, { value: { host, token } }, children);
+}
+var strapiCollectionMeta = {
+  name: "StrapiCollection",
+  displayName: "Strapi Collection",
+  importName: "StrapiCollection",
+  importPath: modulePath,
+  providesData: true,
+  description: "Fetches Strapi data of a given collection, and repeats `children` slot content for each row fetched. [See tutorial video](https://www.youtube.com/watch?v=1SLoVY3hkQ4).",
+  defaultStyles: {
+    display: "grid",
+    gridTemplateColumns: "1fr 1fr 1fr 1fr",
+    gridRowGap: "8px",
+    gridColumnGap: "8px",
+    padding: "8px",
+    maxWidth: "100%"
+  },
+  props: {
+    children: {
+      type: "slot",
+      defaultValue: {
+        type: "vbox",
+        children: {
+          type: "component",
+          name: "StrapiField"
+        }
+      }
+    },
+    name: {
+      type: "string",
+      displayName: "Name",
+      description: "Name of the collection to be fetched.",
+      defaultValueHint: "restaurants"
+    },
+    filterField: {
+      type: "choice",
+      displayName: "Filter field",
+      description: "Field (from Collection) to filter by",
+      options: (props, ctx) => {
+        var _a;
+        return (_a = ctx == null ? void 0 : ctx.strapiFields) != null ? _a : [];
+      },
+      hidden: (props, ctx) => !props.name
+    },
+    filterParameter: {
+      type: "choice",
+      displayName: "Filter Parameter",
+      description: "Field Parameter filter by",
+      options: (props, ctx) => {
+        return queryParameters.map((item) => ({
+          label: item == null ? void 0 : item.label,
+          value: item == null ? void 0 : item.value
+        }));
+      },
+      hidden: (props, ctx) => !props.filterField
+    },
+    filterValue: {
+      type: "string",
+      displayName: "Filter value",
+      description: "Value to filter by, should be of filter field type",
+      hidden: (props, ctx) => !props.filterParameter
+    },
+    limit: {
+      type: "number",
+      displayName: "Limit",
+      description: "Maximum n umber of collections to fetch (0 for unlimited)."
+    },
+    noLayout: {
+      type: "boolean",
+      displayName: "No layout",
+      description: "When set, Strapi Collection will not layout its children; instead, the layout set on its parent element will be used. Useful if you want to set flex gap or control container tag type.",
+      defaultValue: false
+    },
+    noAutoRepeat: {
+      type: "boolean",
+      displayName: "No auto-repeat",
+      description: "Do not automatically repeat children for every category.",
+      defaultValue: false
+    }
+  }
+};
+function StrapiCollection({
+  name,
+  filterParameter,
+  filterValue,
+  filterField,
+  limit,
+  children,
+  className,
+  noLayout,
+  noAutoRepeat,
+  setControlContextData
+}) {
+  const creds = ensure((0, import_react.useContext)(CredentialsContext));
+  if (!creds.host) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a host.");
+  }
+  const query = creds.host + "/api/" + name;
+  const cacheKey = JSON.stringify({
+    creds,
+    name,
+    filterField,
+    filterValue,
+    filterParameter
+  });
+  const data = (0, import_query.usePlasmicQueryData)(cacheKey, async () => {
+    if (!query) {
+      return null;
+    }
+    const requestInit = { method: "GET" };
+    if (creds.token) {
+      requestInit.headers = { Authorization: "Bearer " + creds.token };
+    }
+    const queryParams = qs.stringify({
+      ...filterField && filterParameter && filterValue ? {
+        filters: {
+          [filterField]: {
+            [filterParameter]: filterValue
+          }
+        }
+      } : {},
+      populate: "*"
+    });
+    const resp = await fetch(`${query}?${queryParams}`, requestInit);
+    return resp.json();
+  });
+  if (!(data == null ? void 0 : data.data)) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please configure the Strapi provider with a valid host and token.");
+  }
+  if (!(0, import_dlv.default)(data.data, ["data"])) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a valid collection.");
+  }
+  const collectionData = (0, import_dlv.default)(data.data, ["data"]);
+  const filterFieds = collectionData.flatMap((item) => {
+    const attributes = (0, import_dlv.default)(item, ["attributes"]);
+    const displayableFields = Object.keys(attributes).filter((field) => {
+      var _a, _b;
+      const value = attributes[field];
+      const maybeMime = (_b = (_a = value == null ? void 0 : value.data) == null ? void 0 : _a.attributes) == null ? void 0 : _b.mime;
+      return typeof value !== "object" || typeof maybeMime === "string" && maybeMime.startsWith("image");
+    });
+    return displayableFields;
+  });
+  setControlContextData == null ? void 0 : setControlContextData({
+    strapiFields: uniq(filterFieds != null ? filterFieds : [])
+  });
+  if (filterParameter && !filterValue && !filterField) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a Filter Field and a Filter Value");
+  }
+  if (!filterParameter && filterValue && !filterField) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a Filter Parameter and a Filter Field");
+  }
+  if (!filterParameter && !filterValue && filterField) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a Filter Parameter and a Filter Value");
+  }
+  if (filterParameter && filterValue && !filterField) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a Filter Field");
+  }
+  if (!filterParameter && filterValue && filterField) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a Filter Parameter");
+  }
+  if (filterParameter && !filterValue && filterField) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a Filter Value");
+  }
+  const collection = limit > 0 ? collectionData.slice(0, limit) : collectionData;
+  if (collection.length === 0) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "No collection found ");
+  }
+  const repElements = noAutoRepeat ? children : collection.map((item, index) => /* @__PURE__ */ import_react.default.createElement(
+    import_host.DataProvider,
+    {
+      key: item.id,
+      name: "strapiItem",
+      data: item,
+      hidden: true
+    },
+    /* @__PURE__ */ import_react.default.createElement(import_host.DataProvider, { name: makeDataProviderName(name), data: item }, (0, import_host.repeatedElement)(index, children))
+  ));
+  return /* @__PURE__ */ import_react.default.createElement(import_host.DataProvider, { name: "strapiItems", data: collection }, noLayout ? /* @__PURE__ */ import_react.default.createElement(import_react.default.Fragment, null, " ", repElements, " ") : /* @__PURE__ */ import_react.default.createElement("div", { className }, " ", repElements, " "));
+}
+var strapiFieldMeta = {
+  name: "StrapiField",
+  displayName: "Strapi Field",
+  importName: "StrapiField",
+  importPath: modulePath,
+  props: {
+    path: {
+      type: "choice",
+      options: (props, ctx) => {
+        var _a;
+        return (_a = ctx == null ? void 0 : ctx.fields) != null ? _a : [];
+      },
+      displayName: "Field",
+      description: "Field name"
+    }
+  }
+};
+function StrapiField({
+  className,
+  path,
+  setControlContextData
+}) {
+  var _a, _b;
+  const item = (0, import_host.useSelector)("strapiItem");
+  if (!item) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "StrapiField must be used within a StrapiCollection");
+  }
+  const attributes = (0, import_dlv.default)(item, ["attributes"]);
+  const displayableFields = Object.keys(attributes).filter((field) => {
+    var _a2, _b2;
+    const value = attributes[field];
+    const maybeMime2 = (_b2 = (_a2 = value.data) == null ? void 0 : _a2.attributes) == null ? void 0 : _b2.mime;
+    return typeof value !== "object" || typeof maybeMime2 === "string" && maybeMime2.startsWith("image");
+  });
+  setControlContextData == null ? void 0 : setControlContextData({
+    fields: displayableFields,
+    isImage: false
+  });
+  if (!path) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "StrapiField must specify a field name.");
+  }
+  const data = (0, import_dlv.default)(item, ["attributes", path]);
+  const maybeMime = (_b = (_a = data == null ? void 0 : data.data) == null ? void 0 : _a.attributes) == null ? void 0 : _b.mime;
+  setControlContextData == null ? void 0 : setControlContextData({
+    fields: displayableFields,
+    isImage: typeof maybeMime === "string" && maybeMime.startsWith("image")
+  });
+  if (!data) {
+    return /* @__PURE__ */ import_react.default.createElement("div", null, "Please specify a valid field name.");
+  } else if (typeof maybeMime === "string" && maybeMime.startsWith("image")) {
+    const creds = ensure((0, import_react.useContext)(CredentialsContext));
+    const attrs = data.data.attributes;
+    const img_url = attrs.url.startsWith("http") ? attrs.url : creds.host + attrs.url;
+    const img_width = attrs.width;
+    const img_height = attrs.height;
+    return /* @__PURE__ */ import_react.default.createElement(
+      "img",
+      {
+        className,
+        src: img_url,
+        width: 300,
+        height: 300 * img_height / img_width
+      }
+    );
+  } else {
+    return /* @__PURE__ */ import_react.default.createElement("div", { className }, data);
+  }
+}
+
+// src/index.tsx
+function registerAll(loader) {
+  const _registerComponent = (Component, defaultMeta) => {
+    if (loader) {
+      loader.registerComponent(Component, defaultMeta);
+    } else {
+      (0, import_registerComponent.default)(Component, defaultMeta);
+    }
+  };
+  if (loader) {
+    loader.registerGlobalContext(StrapiCredentialsProvider, strapiCredentialsProviderMeta);
+  } else {
+    (0, import_registerGlobalContext.default)(StrapiCredentialsProvider, strapiCredentialsProviderMeta);
+  }
+  _registerComponent(StrapiCollection, strapiCollectionMeta);
+  _registerComponent(StrapiField, strapiFieldMeta);
 }
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  StrapiCollection,
+  StrapiCredentialsProvider,
+  StrapiField,
+  ensure,
+  registerAll,
+  strapiCollectionMeta,
+  strapiCredentialsProviderMeta,
+  strapiFieldMeta
+});