@plasmicpkgs/airtable 0.0.44 → 0.0.47

package/dist/RecordData.d.ts

@@ -1,6 +1,11 @@
-import { ComponentMeta, GlobalContextMeta, registerComponent, registerGlobalContext } from "@plasmicapp/host";
-import { CanvasComponentProps } from "@plasmicapp/host/dist/registerComponent";
+import registerComponent, { CanvasComponentProps, ComponentMeta } from "@plasmicapp/host/registerComponent";
+import registerGlobalContext, { GlobalContextMeta } from "@plasmicapp/host/registerGlobalContext";
 import React from "react";
+export interface DataSourceInfo {
+    id: string;
+    base: string;
+    host?: string;
+}
 interface RecordData {
     [field: string]: string | {
         id: string;
@@ -9,12 +14,10 @@ interface RecordData {
     }[];
 }
 export interface AirtableRecordProps {
-    dataSourceId?: string;
-    base?: string;
     table: string;
     record: string;
 }
-export declare function AirtableRecord({ table, record, children, ...props }: React.PropsWithChildren<AirtableRecordProps>): JSX.Element;
+export declare function AirtableRecord({ table, record, children, }: React.PropsWithChildren<AirtableRecordProps>): JSX.Element;
 export interface AirtableRecordFieldProps extends CanvasComponentProps<RecordData | undefined> {
     className?: string;
     style?: React.CSSProperties;
@@ -22,8 +25,6 @@ export interface AirtableRecordFieldProps extends CanvasComponentProps<RecordDat
 }
 export declare function AirtableRecordField({ className, field, style, setControlContextData, }: AirtableRecordFieldProps): JSX.Element;
 export interface AirtableCollectionProps {
-    dataSourceId?: string;
-    base?: string;
     table: string;
     fields?: string[];
     filterByFormula?: string;
@@ -37,11 +38,10 @@ export interface AirtableCollectionProps {
 }
 export declare function AirtableCollection({ table, children, ...props }: React.PropsWithChildren<AirtableCollectionProps>): JSX.Element;
 interface AirtableCredentialsProviderProps {
-    dataSourceId: string;
-    base: string;
+    dataSource: DataSourceInfo;
     host?: string;
 }
-export declare function AirtableCredentialsProvider({ base, dataSourceId, host: maybeHost, children, }: React.PropsWithChildren<AirtableCredentialsProviderProps>): JSX.Element;
+export declare function AirtableCredentialsProvider({ dataSource, host: maybeHost, children, }: React.PropsWithChildren<AirtableCredentialsProviderProps>): JSX.Element;
 export declare const airtableRecordMeta: ComponentMeta<AirtableRecordProps>;
 export declare function registerAirtableRecord(loader?: {
     registerComponent: typeof registerComponent;

package/dist/airtable.cjs.development.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
 
 var host = require('@plasmicapp/host');
+var registerComponent = _interopDefault(require('@plasmicapp/host/registerComponent'));
+var registerGlobalContext = _interopDefault(require('@plasmicapp/host/registerGlobalContext'));
 var query = require('@plasmicapp/query');
 var React = _interopDefault(require('react'));
 
@@ -44,6 +46,24 @@ function _asyncToGenerator(fn) {
   };
 }
 
+function _extends() {
+  _extends = Object.assign || function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+
+    return target;
+  };
+
+  return _extends.apply(this, arguments);
+}
+
 function _objectWithoutPropertiesLoose(source, excluded) {
   if (source == null) return {};
   var target = {};
@@ -787,51 +807,62 @@ var runtime_1 = /*#__PURE__*/createCommonjsModule(function (module) {
   }
 });
 
-var _excluded = ["table", "record", "children"],
-    _excluded2 = ["table", "children"];
+var _excluded = ["table", "children"];
 var defaultHost = "https://studio.plasmic.app";
 var CredentialsContext = /*#__PURE__*/React.createContext(undefined);
 function AirtableRecord(_ref) {
-  var _props$base, _props$dataSourceId, _credentialsContext$h;
-
   var table = _ref.table,
       record = _ref.record,
-      children = _ref.children,
-      props = _objectWithoutPropertiesLoose(_ref, _excluded);
-
+      children = _ref.children;
   var credentialsContext = React.useContext(CredentialsContext);
-  var base = (_props$base = props.base) != null ? _props$base : credentialsContext == null ? void 0 : credentialsContext.base;
-  var dataSourceId = (_props$dataSourceId = props.dataSourceId) != null ? _props$dataSourceId : credentialsContext == null ? void 0 : credentialsContext.dataSourceId;
-  var host$1 = (_credentialsContext$h = credentialsContext == null ? void 0 : credentialsContext.host) != null ? _credentialsContext$h : defaultHost;
+  var dataSourceId = credentialsContext && credentialsContext.id;
+  var base = credentialsContext && credentialsContext.base;
+  var host$1 = credentialsContext && credentialsContext.host || defaultHost;
   var data = query.usePlasmicQueryData(JSON.stringify(["AirtableRecord", host$1, base, table, record, dataSourceId]), /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee() {
     var pathname, url;
     return runtime_1.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            if (!(!base || !dataSourceId || !table)) {
+            if (!(!base || !dataSourceId)) {
               _context.next = 2;
               break;
             }
 
-            throw new Error("AirtableRecord needs base ID, table and Data Source ID");
+            throw new Error("Missing Data Source. Please select a Data Source from the Airtable Credentials Provider");
 
           case 2:
+            if (table) {
+              _context.next = 4;
+              break;
+            }
+
+            throw new Error("AirtableRecord is missing the table name");
+
+          case 4:
+            if (record) {
+              _context.next = 6;
+              break;
+            }
+
+            throw new Error("AirtableRecord is missing the record ID");
+
+          case 6:
             pathname = "/" + base + "/" + table + "/" + record;
-            url = host$1 + "/api/v1/server-data-sources/query?pathname=" + encodeURIComponent(pathname) + "&dataSourceId=" + dataSourceId;
-            _context.next = 6;
+            url = host$1 + "/api/v1/server-data/query?pathname=" + encodeURIComponent(pathname) + "&dataSourceId=" + dataSourceId;
+            _context.next = 10;
             return fetch(url, {
               method: "GET"
             });
 
-          case 6:
-            _context.next = 8;
+          case 10:
+            _context.next = 12;
             return _context.sent.json();
 
-          case 8:
+          case 12:
             return _context.abrupt("return", _context.sent.fields);
 
-          case 9:
+          case 13:
           case "end":
             return _context.stop();
         }
@@ -881,16 +912,14 @@ function AirtableRecordField(_ref3) {
   }() : "Error: Must provide a record to AirtableRecordField");
 }
 function AirtableCollection(_ref4) {
-  var _props$base2, _props$dataSourceId2, _credentialsContext$h2;
-
   var table = _ref4.table,
       children = _ref4.children,
-      props = _objectWithoutPropertiesLoose(_ref4, _excluded2);
+      props = _objectWithoutPropertiesLoose(_ref4, _excluded);
 
   var credentialsContext = React.useContext(CredentialsContext);
-  var base = (_props$base2 = props.base) != null ? _props$base2 : credentialsContext == null ? void 0 : credentialsContext.base;
-  var dataSourceId = (_props$dataSourceId2 = props.dataSourceId) != null ? _props$dataSourceId2 : credentialsContext == null ? void 0 : credentialsContext.dataSourceId;
-  var host$1 = (_credentialsContext$h2 = credentialsContext == null ? void 0 : credentialsContext.host) != null ? _credentialsContext$h2 : defaultHost;
+  var dataSourceId = credentialsContext && credentialsContext.id;
+  var base = credentialsContext && credentialsContext.base;
+  var host$1 = credentialsContext && credentialsContext.host || defaultHost;
   var searchArray = [];
 
   if (props.fields) {
@@ -922,29 +951,37 @@ function AirtableCollection(_ref4) {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
-            if (!(!base || !dataSourceId || !table)) {
+            if (!(!base || !dataSourceId)) {
               _context2.next = 2;
               break;
             }
 
-            throw new Error("AirtableRecord needs base ID, table and Data Source ID");
+            throw new Error("Missing Data Source. Please select a Data Source from the Airtable Credentials Provider");
 
           case 2:
+            if (table) {
+              _context2.next = 4;
+              break;
+            }
+
+            throw new Error("AirtableCollection is missing the table name");
+
+          case 4:
             pathname = "/" + base + "/" + table + search;
-            url = host$1 + "/api/v1/server-data-sources/query?pathname=" + encodeURIComponent(pathname) + "&dataSourceId=" + dataSourceId;
-            _context2.next = 6;
+            url = host$1 + "/api/v1/server-data/query?pathname=" + encodeURIComponent(pathname) + "&dataSourceId=" + dataSourceId;
+            _context2.next = 8;
             return fetch(url, {
               method: "GET"
             });
 
-          case 6:
-            _context2.next = 8;
+          case 8:
+            _context2.next = 10;
             return _context2.sent.json();
 
-          case 8:
+          case 10:
             return _context2.abrupt("return", _context2.sent.records);
 
-          case 9:
+          case 11:
           case "end":
             return _context2.stop();
         }
@@ -971,17 +1008,20 @@ function AirtableCollection(_ref4) {
   }));
 }
 function AirtableCredentialsProvider(_ref6) {
-  var base = _ref6.base,
-      dataSourceId = _ref6.dataSourceId,
+  var dataSource = _ref6.dataSource,
       maybeHost = _ref6.host,
       children = _ref6.children;
-  var host = maybeHost || defaultHost;
+  var inCanvas = host.usePlasmicCanvasContext();
+
+  if (inCanvas && (!dataSource || !dataSource.id || !dataSource.base)) {
+    return React.createElement("p", null, "Error: Missing Data Source. Please select a Data Source from the Airtable Credentials Provider");
+  }
+
+  var host$1 = maybeHost || defaultHost;
   return React.createElement(CredentialsContext.Provider, {
-    value: {
-      base: base,
-      dataSourceId: dataSourceId,
-      host: host
-    }
+    value: _extends({}, dataSource, {
+      host: host$1
+    })
   }, children);
 }
 var thisModule = "@plasmicpkgs/airtable";
@@ -1007,18 +1047,6 @@ var airtableRecordMeta = {
       type: "string",
       displayName: "Record",
       description: "The table record ID"
-    },
-    base: {
-      type: "string",
-      displayName: "Base",
-      defaultValueHint: "Read from Credentials Provider",
-      description: "The Airtable Base (if not provided by the Credentials Provider)"
-    },
-    dataSourceId: {
-      type: "string",
-      displayName: "Data Source ID",
-      defaultValueHint: "Read from Credentials Provider",
-      description: "The Data Source ID with the Airtable secrets"
     }
   }
 };
@@ -1026,7 +1054,7 @@ function registerAirtableRecord(loader, customAirtableRecordMeta) {
   if (loader) {
     loader.registerComponent(AirtableRecord, customAirtableRecordMeta != null ? customAirtableRecordMeta : airtableRecordMeta);
   } else {
-    host.registerComponent(AirtableRecord, customAirtableRecordMeta != null ? customAirtableRecordMeta : airtableRecordMeta);
+    registerComponent(AirtableRecord, customAirtableRecordMeta != null ? customAirtableRecordMeta : airtableRecordMeta);
   }
 }
 var airtableRecordFieldMeta = {
@@ -1049,7 +1077,7 @@ function registerAirtableRecordField(loader, customAirtableRecordFieldMeta) {
   if (loader) {
     loader.registerComponent(AirtableRecordField, customAirtableRecordFieldMeta != null ? customAirtableRecordFieldMeta : airtableRecordFieldMeta);
   } else {
-    host.registerComponent(AirtableRecordField, customAirtableRecordFieldMeta != null ? customAirtableRecordFieldMeta : airtableRecordFieldMeta);
+    registerComponent(AirtableRecordField, customAirtableRecordFieldMeta != null ? customAirtableRecordFieldMeta : airtableRecordFieldMeta);
   }
 }
 var airtableCollectionMeta = {
@@ -1098,18 +1126,6 @@ var airtableCollectionMeta = {
       type: "string",
       displayName: "Filter by Formula",
       description: "An Airtable formula used to filter records"
-    },
-    base: {
-      type: "string",
-      displayName: "Base",
-      defaultValueHint: "Read from Credentials Provider",
-      description: "The Airtable Base (if not provided by the Credentials Provider)"
-    },
-    dataSourceId: {
-      type: "string",
-      displayName: "Data Source ID",
-      defaultValueHint: "Read from Credentials Provider",
-      description: "The Data Source ID with the Airtable secrets"
     }
   }
 };
@@ -1117,7 +1133,7 @@ function registerAirtableCollection(loader, customAirtableCollectionMeta) {
   if (loader) {
     loader.registerComponent(AirtableCollection, customAirtableCollectionMeta != null ? customAirtableCollectionMeta : airtableCollectionMeta);
   } else {
-    host.registerComponent(AirtableCollection, customAirtableCollectionMeta != null ? customAirtableCollectionMeta : airtableCollectionMeta);
+    registerComponent(AirtableCollection, customAirtableCollectionMeta != null ? customAirtableCollectionMeta : airtableCollectionMeta);
   }
 }
 var airtableCredentialsProviderMeta = {
@@ -1126,15 +1142,11 @@ var airtableCredentialsProviderMeta = {
   importPath: thisModule,
   importName: "AirtableCredentialsProvider",
   props: {
-    base: {
-      type: "string",
-      displayName: "Base",
-      description: "The Airtable Base"
-    },
-    dataSourceId: {
-      type: "string",
-      displayName: "Data Source ID",
-      description: "The Data Source ID"
+    dataSource: {
+      type: "dataSource",
+      dataSource: "airtable",
+      displayName: "Data Source",
+      description: "The Airtable Data Source to use"
     },
     host: {
       type: "string",
@@ -1148,10 +1160,17 @@ function registerAirtableCredentialsProvider(loader, customAirtableCredentialsPr
   if (loader) {
     loader.registerGlobalContext(AirtableCredentialsProvider, customAirtableCredentialsProviderMeta != null ? customAirtableCredentialsProviderMeta : airtableCredentialsProviderMeta);
   } else {
-    host.registerGlobalContext(AirtableCredentialsProvider, customAirtableCredentialsProviderMeta != null ? customAirtableCredentialsProviderMeta : airtableCredentialsProviderMeta);
+    registerGlobalContext(AirtableCredentialsProvider, customAirtableCredentialsProviderMeta != null ? customAirtableCredentialsProviderMeta : airtableCredentialsProviderMeta);
   }
 }
 
+function registerAll(loader) {
+  registerAirtableCollection(loader);
+  registerAirtableCredentialsProvider(loader);
+  registerAirtableRecord(loader);
+  registerAirtableRecordField(loader);
+}
+
 exports.AirtableCollection = AirtableCollection;
 exports.AirtableCredentialsProvider = AirtableCredentialsProvider;
 exports.AirtableRecord = AirtableRecord;
@@ -1164,4 +1183,5 @@ exports.registerAirtableCollection = registerAirtableCollection;
 exports.registerAirtableCredentialsProvider = registerAirtableCredentialsProvider;
 exports.registerAirtableRecord = registerAirtableRecord;
 exports.registerAirtableRecordField = registerAirtableRecordField;
+exports.registerAll = registerAll;
 //# sourceMappingURL=airtable.cjs.development.js.map