@datocms/svelte 1.2.1 → 1.3.0

package/README.md

@@ -1,3 +1,9 @@
+<!--datocms-autoinclude-header start-->
+<a href="https://www.datocms.com/"><img src="https://www.datocms.com/images/full_logo.svg" height="60"></a>
+
+👉 [Visit the DatoCMS homepage](https://www.datocms.com) or see [What is DatoCMS?](#what-is-datocms)
+<!--datocms-autoinclude-header end-->
+
 # @datocms/svelte
 
 ![MIT](https://img.shields.io/npm/l/@datocms/svelte?style=for-the-badge) ![NPM](https://img.shields.io/npm/v/@datocms/svelte?style=for-the-badge) [![Build Status](https://img.shields.io/github/actions/workflow/status/datocms/datocms-svelte/node.js.yml?branch=main&style=for-the-badge)](https://github.com/datocms/datocms-svelte/actions/workflows/node.js.yml)
@@ -8,12 +14,6 @@ A set of components to work faster with [DatoCMS](https://www.datocms.com/) in S
 - Written in TypeScript;
 - Usable both client and server side;
 
-<br /><br />
-<a href="https://www.datocms.com/">
-<img src="https://www.datocms.com/images/full_logo.svg" height="60">
-</a>
-<br /><br />
-
 ## Table of Contents
 
 - [Features](#features)
@@ -49,3 +49,30 @@ To create a production version of this library:
 ```bash
 npm run build
 ```
+
+<!--datocms-autoinclude-footer start-->
+-----------------
+# What is DatoCMS?
+<a href="https://www.datocms.com/"><img src="https://www.datocms.com/images/full_logo.svg" height="60"></a>
+
+[DatoCMS](https://www.datocms.com/) is the REST & GraphQL Headless CMS for the modern web.
+
+Trusted by over 25,000 enterprise businesses, agency partners, and individuals across the world, DatoCMS users create online content at scale from a central hub and distribute it via API. We ❤️ our [developers](https://www.datocms.com/team/best-cms-for-developers), [content editors](https://www.datocms.com/team/content-creators) and [marketers](https://www.datocms.com/team/cms-digital-marketing)!
+
+**Quick links:**
+
+- ⚡️ Get started with a [free DatoCMS account](https://dashboard.datocms.com/signup)
+- 🔖 Go through the [docs](https://www.datocms.com/docs)
+- ⚙️ Get [support from us and the community](https://community.datocms.com/)
+- 🆕 Stay up to date on new features and fixes on the [changelog](https://www.datocms.com/product-updates)
+
+**Our featured repos:**
+- [datocms/react-datocms](https://github.com/datocms/react-datocms): React helper components for images, Structured Text rendering, and more
+- [datocms/js-rest-api-clients](https://github.com/datocms/js-rest-api-clients): Node and browser JavaScript clients for updating and administering your content. For frontend fetches, we recommend using our [GraphQL Content Delivery API](https://www.datocms.com/docs/content-delivery-api) instead.
+- [datocms/cli](https://github.com/datocms/cli): Command-line interface that includes our [Contentful importer](https://github.com/datocms/cli/tree/main/packages/cli-plugin-contentful) and [Wordpress importer](https://github.com/datocms/cli/tree/main/packages/cli-plugin-wordpress)
+- [datocms/plugins](https://github.com/datocms/plugins): Example plugins we've made that extend the editor/admin dashboard
+- [datocms/gatsby-source-datocms](https://github.com/datocms/gatsby-source-datocms): Our Gatsby source plugin to pull data from DatoCMS
+- Frontend examples in different frameworks: [Next.js](https://github.com/datocms/nextjs-demo), [Vue](https://github.com/datocms/vue-datocms) and [Nuxt](https://github.com/datocms/nuxtjs-demo), [Svelte](https://github.com/datocms/datocms-svelte) and [SvelteKit](https://github.com/datocms/sveltekit-demo), [Astro](https://github.com/datocms/datocms-astro-blog-demo), [Remix](https://github.com/datocms/remix-example). See [all our starter templates](https://www.datocms.com/marketplace/starters).
+
+Or see [all our public repos](https://github.com/orgs/datocms/repositories?q=&type=public&language=&sort=stargazers)
+<!--datocms-autoinclude-footer end-->

package/{components → package/components}/StructuredText/StructuredText.svelte.d.ts

@@ -3,7 +3,7 @@ import { type StructuredText, type Document } from 'datocms-structured-text-util
 import type { PredicateComponentTuple } from '../..';
 declare const __propDef: {
     props: {
-        /** The actual field value you get from DatoCMS **/ data?: StructuredText<import("datocms-structured-text-utils").Record, import("datocms-structured-text-utils").Record> | Document | null | undefined;
+        /** The actual field value you get from DatoCMS **/ data?: StructuredText | Document | null | undefined;
         components?: PredicateComponentTuple[] | undefined;
     };
     events: {

package/{index.d.ts → package/index.d.ts}

@@ -1,9 +1,9 @@
 import type { Node } from 'datocms-structured-text-utils';
-import type { SvelteComponentTyped } from 'svelte';
+import type { SvelteComponent } from 'svelte';
 export { default as StructuredText } from './components/StructuredText/StructuredText.svelte';
 export { default as Image } from './components/Image/Image.svelte';
 export { default as Head } from './components/Head/Head.svelte';
 export type PredicateComponentTuple = [
     (n: Node) => boolean,
-    new (...any: any) => SvelteComponentTyped
+    new (...any: any) => SvelteComponent
 ];

package/package.json

@@ -1,72 +1,224 @@
 {
-  "name": "@datocms/svelte",
-  "version": "1.2.1",
-  "description": "A set of components and utilities to work faster with DatoCMS in Svelte",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/datocms/datocms-svelte.git"
-  },
-  "author": "Silvano Stralla <silvano@datocms.com>",
-  "homepage": "https://github.com/datocms/datocms-svelte",
-  "keywords": [
-    "svelte",
-    "datocms"
-  ],
-  "devDependencies": {
-    "@sveltejs/adapter-auto": "^1.0.3",
-    "@sveltejs/kit": "^1.30.3",
-    "@sveltejs/package": "^1.0.2",
-    "@testing-library/jest-dom": "^5.17.0",
-    "@testing-library/svelte": "^3.2.2",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "csstype": "^3.1.3",
-    "datocms-structured-text-generic-html-renderer": "^2.0.4",
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^8.10.0",
-    "eslint-plugin-svelte3": "^4.0.0",
-    "jsdom": "^21.1.2",
-    "jsdom-testing-mocks": "^1.11.0",
-    "prettier": "^2.8.8",
-    "prettier-plugin-svelte": "^2.10.1",
-    "svelte": "^3.59.2",
-    "svelte-check": "^3.6.2",
-    "tslib": "^2.6.2",
-    "typescript": "^4.9.5",
-    "vite": "^4.5.1",
-    "vitest": "^0.25.8"
-  },
-  "type": "module",
-  "dependencies": {
-    "datocms-structured-text-utils": "^2.0.4",
-    "svelte-intersection-observer": "^0.10.1",
-    "universal-base64": "^2.1.0"
-  },
-  "exports": {
-    "./package.json": "./package.json",
-    "./components/Head/Head.svelte": "./components/Head/Head.svelte",
-    "./components/Head/README.md": "./components/Head/README.md",
-    "./components/Image/Image.svelte": "./components/Image/Image.svelte",
-    "./components/Image/Placeholder.svelte": "./components/Image/Placeholder.svelte",
-    "./components/Image/README.md": "./components/Image/README.md",
-    "./components/Image/Sizer.svelte": "./components/Image/Sizer.svelte",
-    "./components/Image/Source.svelte": "./components/Image/Source.svelte",
-    "./components/StructuredText/Node.svelte": "./components/StructuredText/Node.svelte",
-    "./components/StructuredText/README.md": "./components/StructuredText/README.md",
-    "./components/StructuredText/StructuredText.svelte": "./components/StructuredText/StructuredText.svelte",
-    "./components/StructuredText/nodes/Blockquote.svelte": "./components/StructuredText/nodes/Blockquote.svelte",
-    "./components/StructuredText/nodes/Code.svelte": "./components/StructuredText/nodes/Code.svelte",
-    "./components/StructuredText/nodes/Heading.svelte": "./components/StructuredText/nodes/Heading.svelte",
-    "./components/StructuredText/nodes/Link.svelte": "./components/StructuredText/nodes/Link.svelte",
-    "./components/StructuredText/nodes/List.svelte": "./components/StructuredText/nodes/List.svelte",
-    "./components/StructuredText/nodes/ListItem.svelte": "./components/StructuredText/nodes/ListItem.svelte",
-    "./components/StructuredText/nodes/Paragraph.svelte": "./components/StructuredText/nodes/Paragraph.svelte",
-    "./components/StructuredText/nodes/Root.svelte": "./components/StructuredText/nodes/Root.svelte",
-    "./components/StructuredText/nodes/Span.svelte": "./components/StructuredText/nodes/Span.svelte",
-    "./components/StructuredText/nodes/ThematicBreak.svelte": "./components/StructuredText/nodes/ThematicBreak.svelte",
-    "./components/StructuredText/utils/Lines.svelte": "./components/StructuredText/utils/Lines.svelte",
-    ".": "./index.js"
-  },
-  "svelte": "./index.js"
+	"name": "@datocms/svelte",
+	"version": "1.3.0",
+	"description": "A set of components and utilities to work faster with DatoCMS in Svelte",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git://github.com/datocms/datocms-svelte.git"
+	},
+	"author": "Silvano Stralla <silvano@datocms.com>",
+	"homepage": "https://github.com/datocms/datocms-svelte",
+	"keywords": [
+		"svelte",
+		"datocms"
+	],
+	"scripts": {
+		"dev": "vite dev",
+		"build": "svelte-kit sync && svelte-package -o package",
+		"prepublishOnly": "npm run build",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"test:unit": "vitest",
+		"test": "npm run test:unit",
+		"lint": "prettier --plugin-search-dir . --check . && eslint .",
+		"format": "prettier --plugin-search-dir . --write ."
+	},
+	"devDependencies": {
+		"@sveltejs/adapter-auto": "^3.0.0",
+		"@sveltejs/kit": "^2.0.0",
+		"@sveltejs/package": "^2.0.0",
+		"@sveltejs/vite-plugin-svelte": "^3.0.0",
+		"@testing-library/jest-dom": "^5.17.0",
+		"@testing-library/svelte": "^4.1.0",
+		"@typescript-eslint/eslint-plugin": "^5.62.0",
+		"@typescript-eslint/parser": "^5.62.0",
+		"csstype": "^3.1.3",
+		"datocms-structured-text-generic-html-renderer": "^2.0.4",
+		"eslint": "^8.56.0",
+		"eslint-config-prettier": "^8.10.0",
+		"eslint-plugin-svelte": "^2.35.1",
+		"jsdom": "^21.1.2",
+		"jsdom-testing-mocks": "^1.11.0",
+		"prettier": "^2.8.8",
+		"prettier-plugin-svelte": "^2.10.1",
+		"svelte": "^4.0.0",
+		"svelte-check": "^3.6.2",
+		"tslib": "^2.6.2",
+		"typescript": "^5.0.0",
+		"vite": "^5.0.0",
+		"vitest": "^1.0.0"
+	},
+	"peerDependencies": {
+		"svelte": "^3.59.2 || ^4.0.0"
+	},
+	"type": "module",
+	"dependencies": {
+		"datocms-structured-text-utils": "^2.0.4",
+		"svelte-intersection-observer": "^1.0.0",
+		"universal-base64": "^2.1.0"
+	},
+	"exports": {
+		"./package.json": "./package.json",
+		"./components/Head/Head.svelte": {
+			"types": "./package/components/Head/Head.svelte.d.ts",
+			"svelte": "./package/components/Head/Head.svelte",
+			"default": "./package/components/Head/Head.svelte"
+		},
+		"./components/Image/Image.svelte": {
+			"types": "./package/components/Image/Image.svelte.d.ts",
+			"svelte": "./package/components/Image/Image.svelte",
+			"default": "./package/components/Image/Image.svelte"
+		},
+		"./components/Image/Placeholder.svelte": {
+			"types": "./package/components/Image/Placeholder.svelte.d.ts",
+			"svelte": "./package/components/Image/Placeholder.svelte",
+			"default": "./package/components/Image/Placeholder.svelte"
+		},
+		"./components/Image/Sizer.svelte": {
+			"types": "./package/components/Image/Sizer.svelte.d.ts",
+			"svelte": "./package/components/Image/Sizer.svelte",
+			"default": "./package/components/Image/Sizer.svelte"
+		},
+		"./components/Image/Source.svelte": {
+			"types": "./package/components/Image/Source.svelte.d.ts",
+			"svelte": "./package/components/Image/Source.svelte",
+			"default": "./package/components/Image/Source.svelte"
+		},
+		"./components/StructuredText/Node.svelte": {
+			"types": "./package/components/StructuredText/Node.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/Node.svelte",
+			"default": "./package/components/StructuredText/Node.svelte"
+		},
+		"./components/StructuredText/StructuredText.svelte": {
+			"types": "./package/components/StructuredText/StructuredText.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/StructuredText.svelte",
+			"default": "./package/components/StructuredText/StructuredText.svelte"
+		},
+		"./components/StructuredText/nodes/Blockquote.svelte": {
+			"types": "./package/components/StructuredText/nodes/Blockquote.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/Blockquote.svelte",
+			"default": "./package/components/StructuredText/nodes/Blockquote.svelte"
+		},
+		"./components/StructuredText/nodes/Code.svelte": {
+			"types": "./package/components/StructuredText/nodes/Code.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/Code.svelte",
+			"default": "./package/components/StructuredText/nodes/Code.svelte"
+		},
+		"./components/StructuredText/nodes/Heading.svelte": {
+			"types": "./package/components/StructuredText/nodes/Heading.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/Heading.svelte",
+			"default": "./package/components/StructuredText/nodes/Heading.svelte"
+		},
+		"./components/StructuredText/nodes/Link.svelte": {
+			"types": "./package/components/StructuredText/nodes/Link.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/Link.svelte",
+			"default": "./package/components/StructuredText/nodes/Link.svelte"
+		},
+		"./components/StructuredText/nodes/List.svelte": {
+			"types": "./package/components/StructuredText/nodes/List.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/List.svelte",
+			"default": "./package/components/StructuredText/nodes/List.svelte"
+		},
+		"./components/StructuredText/nodes/ListItem.svelte": {
+			"types": "./package/components/StructuredText/nodes/ListItem.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/ListItem.svelte",
+			"default": "./package/components/StructuredText/nodes/ListItem.svelte"
+		},
+		"./components/StructuredText/nodes/Paragraph.svelte": {
+			"types": "./package/components/StructuredText/nodes/Paragraph.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/Paragraph.svelte",
+			"default": "./package/components/StructuredText/nodes/Paragraph.svelte"
+		},
+		"./components/StructuredText/nodes/Root.svelte": {
+			"types": "./package/components/StructuredText/nodes/Root.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/Root.svelte",
+			"default": "./package/components/StructuredText/nodes/Root.svelte"
+		},
+		"./components/StructuredText/nodes/Span.svelte": {
+			"types": "./package/components/StructuredText/nodes/Span.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/Span.svelte",
+			"default": "./package/components/StructuredText/nodes/Span.svelte"
+		},
+		"./components/StructuredText/nodes/ThematicBreak.svelte": {
+			"types": "./package/components/StructuredText/nodes/ThematicBreak.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/nodes/ThematicBreak.svelte",
+			"default": "./package/components/StructuredText/nodes/ThematicBreak.svelte"
+		},
+		"./components/StructuredText/utils/Lines.svelte": {
+			"types": "./package/components/StructuredText/utils/Lines.svelte.d.ts",
+			"svelte": "./package/components/StructuredText/utils/Lines.svelte",
+			"default": "./package/components/StructuredText/utils/Lines.svelte"
+		},
+		".": {
+			"types": "./package/index.d.ts",
+			"svelte": "./package/index.js",
+			"default": "./package/index.js"
+		}
+	},
+	"files": [
+		"package"
+	],
+	"svelte": "./package/index.js",
+	"typesVersions": {
+		">4.0": {
+			"components/Head/Head.svelte": [
+				"./package/components/Head/Head.svelte.d.ts"
+			],
+			"components/Image/Image.svelte": [
+				"./package/components/Image/Image.svelte.d.ts"
+			],
+			"components/Image/Placeholder.svelte": [
+				"./package/components/Image/Placeholder.svelte.d.ts"
+			],
+			"components/Image/Sizer.svelte": [
+				"./package/components/Image/Sizer.svelte.d.ts"
+			],
+			"components/Image/Source.svelte": [
+				"./package/components/Image/Source.svelte.d.ts"
+			],
+			"components/StructuredText/Node.svelte": [
+				"./package/components/StructuredText/Node.svelte.d.ts"
+			],
+			"components/StructuredText/StructuredText.svelte": [
+				"./package/components/StructuredText/StructuredText.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/Blockquote.svelte": [
+				"./package/components/StructuredText/nodes/Blockquote.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/Code.svelte": [
+				"./package/components/StructuredText/nodes/Code.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/Heading.svelte": [
+				"./package/components/StructuredText/nodes/Heading.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/Link.svelte": [
+				"./package/components/StructuredText/nodes/Link.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/List.svelte": [
+				"./package/components/StructuredText/nodes/List.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/ListItem.svelte": [
+				"./package/components/StructuredText/nodes/ListItem.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/Paragraph.svelte": [
+				"./package/components/StructuredText/nodes/Paragraph.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/Root.svelte": [
+				"./package/components/StructuredText/nodes/Root.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/Span.svelte": [
+				"./package/components/StructuredText/nodes/Span.svelte.d.ts"
+			],
+			"components/StructuredText/nodes/ThematicBreak.svelte": [
+				"./package/components/StructuredText/nodes/ThematicBreak.svelte.d.ts"
+			],
+			"components/StructuredText/utils/Lines.svelte": [
+				"./package/components/StructuredText/utils/Lines.svelte.d.ts"
+			],
+			"index.d.ts": [
+				"./package/index.d.ts"
+			]
+		}
+	}
 }

package/components/Head/__tests__/Head.test.d.ts

@@ -1 +0,0 @@
-import '@testing-library/jest-dom';

package/components/Head/__tests__/Head.test.js

@@ -1,11 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import '@testing-library/jest-dom';
-import { render, } from '@testing-library/svelte';
-import { Head } from '../../..';
-import { metaTags } from './__fixtures__/head';
-describe('Head', () => {
-    it('renders meta tags', () => {
-        const { container } = render(Head, { props: { data: metaTags } });
-        expect(container.ownerDocument.head).toMatchSnapshot();
-    });
-});

package/components/Head/__tests__/__fixtures__/head.d.ts

@@ -1,2 +0,0 @@
-import type { TitleMetaLinkTag } from '../../Head.svelte';
-export declare const metaTags: TitleMetaLinkTag[];