@fils/sanity-components 0.0.1

package/README.md

@@ -0,0 +1,25 @@
+# @fils/sanity
+Front-End Utils for Sanity Back-Ends.
+
+You will need top have a `.env` file properly set up in your project.
+
+This is part of a series of packages that we use in our studio for personal and commercial web & [THREEjs](https://threejs.org) based work. It might remain undocumented for a long while but feel free to try it out!
+
+### License
+© Copyright 2025, fil studio
+
+[fil](https://fil.studio) is a studio with a creative tech soul. We build bespoke interactive journeys primarily using modern web technologies. We deliver tailored solutions for installations and on-line experiences using our internal toolkit + [ThreeJS](https://threejs.org).
+
+fil is the Catalan word for thread. We love threads cause we often talk about them when building applications and, at the same time, threads are something so organic, colourful and playful.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/lib/components/core/SEO.d.ts

@@ -0,0 +1,12 @@
+export declare const SEO: {
+    type: "document";
+    name: "seo";
+} & Omit<import("sanity").DocumentDefinition, "preview"> & {
+    preview?: import("sanity").PreviewConfig<Record<string, string>, Record<never, any>> | undefined;
+};
+export declare const LocalizedSEO: {
+    type: "document";
+    name: "localseo";
+} & Omit<import("sanity").DocumentDefinition, "preview"> & {
+    preview?: import("sanity").PreviewConfig<Record<string, string>, Record<never, any>> | undefined;
+};

package/lib/components/core/SEO.js

@@ -0,0 +1,34 @@
+import { defineField, defineType } from "sanity";
+import { SEOImage } from "./SEOImage";
+export const SEO = defineType({
+    name: 'seo',
+    title: "SEO",
+    type: "document",
+    fields: [
+        defineField({
+            name: 'title',
+            type: 'string'
+        }),
+        defineField({
+            name: 'description',
+            type: 'text'
+        }),
+        SEOImage
+    ]
+});
+export const LocalizedSEO = defineType({
+    name: 'localseo',
+    title: "SEO",
+    type: "document",
+    fields: [
+        defineField({
+            name: 'title',
+            type: 'internationalizedArrayString'
+        }),
+        defineField({
+            name: 'description',
+            type: 'internationalizedArrayText'
+        }),
+        SEOImage
+    ]
+});

package/lib/components/core/SEOImage.d.ts

@@ -0,0 +1,6 @@
+export declare const SEOImage: {
+    type: "image";
+    name: "card";
+} & Omit<import("sanity").ImageDefinition, "preview"> & {
+    preview?: import("sanity").PreviewConfig<Record<string, string>, Record<never, any>> | undefined;
+} & import("sanity").FieldDefinitionBase & import("sanity").WidenValidation & import("sanity").WidenInitialValue;

package/lib/components/core/SEOImage.js

@@ -0,0 +1,7 @@
+import { defineField } from "sanity";
+export const SEOImage = defineField({
+    name: 'card',
+    type: 'image',
+    title: 'Sharing Image',
+    description: "Used on site embedding preview. Optimal size is at 1200px x 600px"
+});

package/lib/config/utils.d.ts

@@ -0,0 +1,20 @@
+import { DocumentActionComponent, DocumentActionsContext } from "sanity";
+import { StructureResolver } from 'sanity/structure';
+export declare function getActions(singletonTypes: Set<string>): (input: DocumentActionComponent[], context: DocumentActionsContext) => DocumentActionComponent[];
+export declare function getDefaultConfig(projectId: string, title: string, structure: StructureResolver, schemaTypes: any, singletonTypes: Set<string>): {
+    name: string;
+    title: string;
+    projectId: string;
+    dataset: string;
+    scheduledPublishing: {
+        enabled: false;
+    };
+    plugins: import("sanity").PluginOptions[];
+    schema: {
+        types: any;
+        templates: (templates: import("sanity").Template<any, any>[]) => import("sanity").Template<any, any>[];
+    };
+    document: {
+        actions: (input: DocumentActionComponent[], context: DocumentActionsContext) => DocumentActionComponent[];
+    };
+};

package/lib/config/utils.js

@@ -0,0 +1,33 @@
+import { defineConfig } from "sanity";
+import { structureTool } from 'sanity/structure';
+// Define the actions that should be available for singleton documents
+const singletonActions = new Set(["publish", "discardChanges", "restore"]);
+export function getActions(singletonTypes) {
+    return (input, context) => singletonTypes.has(context.schemaType)
+        ? input.filter(({ action }) => action && singletonActions.has(action))
+        : input;
+}
+export function getDefaultConfig(projectId, title, structure, schemaTypes, singletonTypes) {
+    return defineConfig({
+        name: 'default',
+        title,
+        projectId,
+        dataset: 'production',
+        scheduledPublishing: {
+            enabled: false
+        },
+        plugins: [structureTool({
+                structure
+            })],
+        schema: {
+            types: schemaTypes,
+            // Filter out singleton types from the global “New document” menu options
+            templates: (templates) => templates.filter(({ schemaType }) => !singletonTypes.has(schemaType)),
+        },
+        document: {
+            // For singleton types, filter out actions that are not explicitly included
+            // in the `singletonActions` list defined above
+            actions: getActions(singletonTypes),
+        },
+    });
+}

package/lib/main.d.ts

@@ -0,0 +1,2 @@
+export * from './components/core/SEO';
+export * from './config/utils';

package/lib/main.js

@@ -0,0 +1,2 @@
+export * from './components/core/SEO';
+export * from './config/utils';

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@fils/sanity-components",
+  "version": "0.0.1",
+  "description": "Fil's Components for Sanity Back-Ends",
+  "main": "src/main.cjs",
+  "repository": "git@github.com:fil-studio/fils.git",
+  "author": "Fil Studio <hello@fil.studio>",
+  "license": "Apache-2.0",
+  "private": false,
+  "scripts": {
+    "prepare": "yarn build",
+    "build": "tsc"
+  },
+  "files": [
+    "lib"
+  ],
+  "dependencies": {
+    "sanity": "^3.85.1"
+  },
+  "devDependencies": {
+    "@sanity/types": "^3.85.1",
+    "@types/react": "^19.1.2",
+    "@types/react-dom": "^19.1.2",
+    "typescript": "^5.8.3"
+  }
+}