drupal-decoupled 0.1.0 → 0.2.0

package/README.md

@@ -1,61 +1,22 @@
-# Drupal-Decoupled
-
-A list of utilities for a Decoupled integrations
-
-### Route Syncronization and comunication between FE and BE via the Iframe
-
-Import the `syncDrupalPreviewRoutes` helper at `app/root.tsx`
-
-```typescript
-import { syncDrupalPreviewRoutes } from "drupal-remix";
-```
-
-Make sure your loader returns the current `environment` value
-
-```typescript
-export const loader = async ({ context }: LoaderFunctionArgs ) => {
-  // Provide a variable to define the environment
-  const environment = context.cloudflare.env.ENVIRONMENT
-  return json(
-    {
-      environment,
-    },
-    { status: 200 }
-  );
-};
-```
-
-> NOTE: This example is using Cloudflare and taking advantage of Environemt Settings to define "environment" key/value, that is why we are using the `context.cloudflare.env.ENVIRONMENT` object to obtain the value and pass it from Server to Client.
-
-Upate your `App` function
-
-```typescript
-export default function App() {
-  // read environment from loader
-  const { environment } = useLoaderData<typeof loader>();
-  // use the useNavigation hook from @remix-run/react
-  const navigation = useNavigation();
-
-  // check if environment is preview and navigation.state is loading
-  // to call syncDrupalPreviewRoutes
-  if (environment === "preview" && navigation.state === "loading") {
-    syncDrupalPreviewRoutes(navigation.location.pathname);
-  }
-
-  return (
-    <>
-      <Outlet />
-    </>
-  );
-}
-```
-
-For a fully functional example visit any of those repositories:
-- GraphQL:
-  - [Remix](https://github.com/octahedroid/drupal-remix/tree/main/examples/graphql)
-  - [Drupal]()
-
-- JSON:API (TBD)
+# Build Drupal Decoupled Sites Faster & Smarter
+
+Using Drupal as a headless CMS with a Decoupled front-end implementation is a great way to get an enterprise-quality CMS, paired with a great modern development experience using Remix, Next.js, Astro and/or others.
+
+Unlock the full potential of Drupal as an API-first CMS. Our quick-start guides and ready-to-use examples help you get started in no time!
+
+## Explore Drupal Decoupled
+
+Visit the [docs](https://drupal-decoupled.octahedroid.com/) to see how to use this project.
+
+### Quickstart
+- [Drupal](https://drupal-decoupled.octahedroid.com/docs/getting-started/quickstart/drupal)
+- [Remix](https://drupal-decoupled.octahedroid.com/docs/getting-started/quickstart/remix)
+- [Next.js](https://drupal-decoupled.octahedroid.com/docs/getting-started/quickstart/next)
+
+### Step by step
+- [Drupal](https://drupal-decoupled.octahedroid.com/docs/getting-started/step-by-step/drupal)
+- [Remix](https://drupal-decoupled.octahedroid.com/docs/getting-started/step-by-step/starters/remix)
+- [Next.js](https://drupal-decoupled.octahedroid.com/docs/getting-started/step-by-step/starters/next)
 
 ## Supporting organizations
 

package/dist/remix/index.d.ts

@@ -0,0 +1 @@
+export * from "./seo";

package/dist/remix/index.js

@@ -0,0 +1 @@
+var l=[{charSet:"utf-8"},{name:"viewport",content:"width=device-width,initial-scale=1"}],c=(e,o)=>typeof e=="string"?e:(Array.isArray(e)||(e=[e]),e.reduce((g,{pattern:s,replacement:p})=>g?.replace(s,p),o)),T=({tags:e,defaultTags:o=[],metaTagOverrides:g})=>{let s=e.find(t=>t.__typename==="MetaTagValue"&&t.attributes.name==="title"),p=e.map(t=>{let u=g?.[t.__typename];if(t.__typename==="MetaTagLink"){let{rel:n,href:a}=t.attributes,r=u?.[n];if(!r)return{tagName:"link",rel:n,href:a};let i=c(r,a);return{tagName:"link",rel:n,href:i}}if(t.__typename==="MetaTagProperty"){let{property:n,content:a}=t.attributes,r=u?.[n];if(!r)return{property:t.attributes.property,content:t.attributes.content};let i=c(r,a);return{property:n,content:i}}if(t.__typename==="MetaTagValue"){let{name:n,content:a}=t.attributes,r=u?.[n];if(!r)return{name:t.attributes.name,content:t.attributes.content};let i=c(r,a);return{name:n,content:i}}});return[...l,...o,s?{title:s.attributes.content}:{},...p]};export{T as metaTags};

package/dist/remix/seo.d.ts

@@ -0,0 +1,66 @@
+type MetaDescriptor = {
+    charSet: "utf-8";
+} | {
+    title: string;
+} | {
+    name: string;
+    content: string;
+} | {
+    property: string;
+    content: string;
+} | {
+    httpEquiv: string;
+    content: string;
+} | {
+    [name: string]: string;
+    tagName: "meta" | "link";
+} | {
+    [name: string]: unknown;
+};
+type MetaTagUnion = (MetaTagLink | MetaTagValue | MetaTagProperty) & {
+    __isUnion?: true;
+};
+interface MetaTagLink {
+    attributes: MetaTagLinkAttributes;
+    __typename: "MetaTagLink";
+}
+export type MetaTag = MetaTagLink | MetaTagValue | MetaTagProperty;
+interface MetaTagLinkAttributes {
+    rel?: string | null;
+    href?: string | null;
+}
+interface MetaTagValue {
+    attributes: MetaTagValueAttributes;
+    __typename: "MetaTagValue";
+}
+interface MetaTagValueAttributes {
+    name?: string | null;
+    content?: string | null;
+}
+interface MetaTagProperty {
+    attributes: MetaTagPropertyAttributes;
+    __typename: "MetaTagProperty";
+}
+interface MetaTagPropertyAttributes {
+    property?: string | null;
+    content?: string | null;
+}
+type OverrideOptionsReplace = {
+    kind: string;
+    pattern: string;
+    replacement: string;
+}[];
+type OverrideOptions = string | OverrideOptionsReplace;
+type MetaTagOverrides = {
+    [key in MetaTagUnion["__typename"]]?: {
+        [key: string]: OverrideOptions;
+    };
+};
+export declare const metaTags: ({ tags, defaultTags, metaTagOverrides, }: {
+    tags: MetaTag[];
+    defaultTags?: {
+        [key: string]: string | undefined;
+    }[] | undefined;
+    metaTagOverrides?: MetaTagOverrides | undefined;
+}) => Array<MetaDescriptor>;
+export {};

package/dist/remix/seo.js

@@ -0,0 +1 @@
+var l=[{charSet:"utf-8"},{name:"viewport",content:"width=device-width,initial-scale=1"}],c=(e,o)=>typeof e=="string"?e:(Array.isArray(e)||(e=[e]),e.reduce((g,{pattern:s,replacement:p})=>g?.replace(s,p),o)),T=({tags:e,defaultTags:o=[],metaTagOverrides:g})=>{let s=e.find(t=>t.__typename==="MetaTagValue"&&t.attributes.name==="title"),p=e.map(t=>{let u=g?.[t.__typename];if(t.__typename==="MetaTagLink"){let{rel:n,href:a}=t.attributes,r=u?.[n];if(!r)return{tagName:"link",rel:n,href:a};let i=c(r,a);return{tagName:"link",rel:n,href:i}}if(t.__typename==="MetaTagProperty"){let{property:n,content:a}=t.attributes,r=u?.[n];if(!r)return{property:t.attributes.property,content:t.attributes.content};let i=c(r,a);return{property:n,content:i}}if(t.__typename==="MetaTagValue"){let{name:n,content:a}=t.attributes,r=u?.[n];if(!r)return{name:t.attributes.name,content:t.attributes.content};let i=c(r,a);return{name:n,content:i}}});return[...l,...o,s?{title:s.attributes.content}:{},...p]};export{T as metaTags};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drupal-decoupled",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Drupal utils for Decoupled integrations",
   "type": "module",
   "keywords": [
@@ -27,14 +27,27 @@
   },
   "author": "Octahedroid <opensource@octahedroid.com>",
   "repository": {
-    "url": "https://github.com/octahedroid/drupal-decoupled/tree/main/packages/drupal-decoupled"
+    "url": "git+https://github.com/octahedroid/drupal-decoupled.git#main"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./remix": "./dist/remix/index.js"
   },
   "license": "MIT",
+  "dependencies": {
+    "@measured/puck": "^0.18.1",
+    "immutable-json-patch": "^6.0.1",
+    "jmespath": "^0.16.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
   "devDependencies": {
+    "@types/jmespath": "^0.15.2",
     "@types/node": "^18.11.3",
+    "@types/react": "^18.2.20",
+    "@types/react-dom": "^18.2.7",
     "esbuild": "^0.17.18",
     "rimraf": "^5.0.0",
     "typescript": "^4.8.4"
-  },
-  "dependencies": {}
+  }
 }