npm - zerocodejs - Versions diffs - 1.0.1-beta.0 - Mend

zerocodejs 1.0.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (154) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2025 Atsumi
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,161 @@
+# ZeroCode.js
+フレームワーク非依存のWeb ComponentsベースのCMSエディターライブラリ
+> **Status: Beta**
+>
+> ZeroCode.js は現在ベータ版です。仕様・API・データ形式は予告なく変更される可能性があります（破壊的変更を含む）。
+> 不具合報告・改善提案・ユースケース共有・ドキュメントのズレの指摘を歓迎します。
+>
+> - **Issue**: [../../issues](../../issues)
+> - **Discussion**: [../../discussions](../../discussions)（運用していない場合は Issue でOK）
+> - **Contributing**: [./CONTRIBUTING.md](./CONTRIBUTING.md)
+> ⭐ **スターをお願いします**
+> このプロジェクトに共感していただけたら、[GitHub でスター](https://github.com/atsumi-code/zerocode)をいただけると励みになります。
+## 特徴
+- **フレームワーク非依存**: Web Componentsとして実装されているため、どのフレームワークでも使用可能
+- **視覚的編集**: クリック操作でコンテンツを編集・追加・削除・並べ替え
+- **パーツ管理**: 再利用可能なパーツを作成・管理
+- **画像管理**: 画像のアップロード・管理機能
+- **柔軟なテンプレート**: カスタムHTMLテンプレート構文で動的なコンテンツを定義
+- **高速**: Vue 3とViteによる高速な開発体験
+## インストール
+```bash
+npm install zerocodejs
+```
+ZeroCode.jsは内部でVue 3を使用しています。npm 7以降では、peer dependenciesが自動的にインストールされるため、`npm install zerocodejs`だけでVueも一緒にインストールされます。
+> **注意:** npm 6以前を使用している場合は、明示的に`npm install zerocodejs vue`を実行してください。
+## クイックスタート
+### 基本的な使用例
+```html
+<!DOCTYPE html>
+<html lang="ja">
+<head>
+  <meta charset="UTF-8">
+  <title>ZeroCode.js Example</title>
+  <link rel="stylesheet" href="node_modules/zerocodejs/dist/style.css">
+</head>
+<body>
+  <zcode-cms id="cms" locale="ja">
+    <link slot="css" rel="stylesheet" href="/css/common.css" />
+    <script slot="script" src="/js/accordion.js"></script>
+  </zcode-cms>
+  <script type="module">
+    import 'zerocodejs';
+    const cms = document.getElementById('cms');
+    cms.setAttribute('page', JSON.stringify([]));
+    cms.setAttribute('parts-common', JSON.stringify([]));
+    cms.setAttribute('parts-individual', JSON.stringify([]));
+    cms.setAttribute('parts-special', JSON.stringify([]));
+    cms.setAttribute('images-common', JSON.stringify([]));
+    cms.setAttribute('images-individual', JSON.stringify([]));
+    cms.setAttribute('images-special', JSON.stringify([]));
+  </script>
+</body>
+</html>
+```
+### Reactでの使用例
+```bash
+npm install zerocodejs
+```
+```jsx
+import { useEffect } from 'react';
+import 'zerocodejs';
+import 'zerocodejs/style.css';
+function App() {
+  useEffect(() => {
+    const cms = document.getElementById('cms');
+    if (cms) {
+      cms.setAttribute('page', JSON.stringify([]));
+      cms.setAttribute('parts-common', JSON.stringify([]));
+      cms.setAttribute('parts-individual', JSON.stringify([]));
+      cms.setAttribute('parts-special', JSON.stringify([]));
+      cms.setAttribute('images-common', JSON.stringify([]));
+      cms.setAttribute('images-individual', JSON.stringify([]));
+      cms.setAttribute('images-special', JSON.stringify([]));
+    }
+  }, []);
+  return <zcode-cms id="cms" locale="ja" />;
+}
+```
+### Vueでの使用例
+```bash
+npm install zerocodejs
+# Vueは既にインストール済み
+```
+```vue
+<template>
+  <zcode-cms id="cms" locale="ja" />
+</template>
+<script setup>
+import 'zerocodejs';
+import 'zerocodejs/style.css';
+</script>
+```
+### エンジニア用管理画面
+```html
+<zcode-editor id="editor" locale="ja">
+  <link slot="css" rel="stylesheet" href="/css/common.css" />
+  <script slot="script" src="/js/accordion.js"></script>
+</zcode-editor>
+```
+### CDN経由で使用する場合
+```html
+<!-- Vueを先に読み込む -->
+<script src="https://unpkg.com/vue@3/dist/vue.global.js"></script>
+<!-- ZeroCode.jsを読み込む -->
+<script src="https://unpkg.com/zerocodejs/dist/zerocode.umd.js"></script>
+<link rel="stylesheet" href="https://unpkg.com/zerocodejs/dist/style.css">
+```
+## ドキュメント
+- [技術仕様書](./TECHNICAL_SPECIFICATION.md)
+- [実装TODO](./TODO.md)
+- [AI向けガイドライン](./AGENTS.md)
+## セキュリティ
+ZeroCode.jsはフロントエンドライブラリのため、クライアント側での完全なセキュリティ保証はできません。
+### 推奨事項
+- **サーバー側での検証を必須とする**: データ保存前にサーバー側で検証してください
+- **認証・認可の実装**: パーツデータの変更は認証されたユーザーのみ許可してください
+- **送信元の検証**: `save-request`イベントの`source`フィールドを確認してください
+- **パーツテンプレートの管理**: パーツテンプレートは信頼できるソースからのみ使用してください
+詳細は[技術仕様書](./TECHNICAL_SPECIFICATION.md)のセキュリティセクションを参照してください。
+## ライセンス
+MIT License
+---
+**最終更新日**: 2025年1月

package/dist/__tests__/fixtures/sample-data.d.ts ADDED Viewed

@@ -0,0 +1,23 @@
+import { ComponentData, PartData, TypeData, ZeroCodeData, ImageData } from '../../types';
+export declare const sampleComponentData: ComponentData;
+export declare const samplePartData: PartData;
+export declare const sampleTypeData: TypeData;
+export declare const sampleImageData: ImageData[];
+export declare const sampleZeroCodeData: ZeroCodeData;
+export declare const sampleBackendData: {
+    user: {
+        name: string;
+        email: string;
+        profile: {
+            age: number;
+            city: string;
+        };
+    };
+    items: {
+        id: number;
+        name: string;
+        price: number;
+    }[];
+    shop_id: string;
+};
+//# sourceMappingURL=sample-data.d.ts.map

package/dist/__tests__/fixtures/sample-data.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"sample-data.d.ts","sourceRoot":"","sources":["../../../src/__tests__/fixtures/sample-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE9F,eAAO,MAAM,mBAAmB,EAAE,aAUjC,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,QAK5B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,QAK5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,SAAS,EAWtC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,YA2BhC,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;CAc7B,CAAC"}

package/dist/__tests__/fixtures/sample-templates.d.ts ADDED Viewed

@@ -0,0 +1,25 @@
+export declare const sampleTemplates: {
+    simpleText: string;
+    optionalField: string;
+    withValidation: string;
+    groupedField: string;
+    richText: string;
+    optionalRichText: string;
+    textarea: string;
+    image: string;
+    radio: string;
+    checkbox: string;
+    select: string;
+    selectMultiple: string;
+    zIf: string;
+    zEmpty: string;
+    zTag: string;
+    zFor: string;
+    zSlot: string;
+    backendData: string;
+    nestedBackendData: string;
+    arrayBackendData: string;
+    urlPlaceholder: string;
+    complex: string;
+};
+//# sourceMappingURL=sample-templates.d.ts.map

package/dist/__tests__/fixtures/sample-templates.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"sample-templates.d.ts","sourceRoot":"","sources":["../../../src/__tests__/fixtures/sample-templates.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;CAgC3B,CAAC"}

package/dist/components/ZeroCodeCMS.vue.d.ts ADDED Viewed

@@ -0,0 +1,142 @@
+import { validateData as validateDataUtil } from '../core/utils/validation';
+type __VLS_Props = {
+    locale?: string;
+    page?: string;
+    cssCommon?: string;
+    cssIndividual?: string;
+    cssSpecial?: string;
+    partsCommon?: string;
+    partsIndividual?: string;
+    partsSpecial?: string;
+    imagesCommon?: string;
+    imagesIndividual?: string;
+    imagesSpecial?: string;
+    config?: string;
+    endpoints?: string;
+    backendData?: string;
+};
+declare function getData(path?: string): unknown;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    getData: typeof getData;
+    setData: (pathOrData: string | Partial<import('..').ZeroCodeData>, value?: unknown) => void;
+    validateData: typeof validateDataUtil;
+    cmsData: {
+        page: {
+            [x: string]: unknown;
+            id: string;
+            part_id: string;
+            slots?: Record<string, import('..').ComponentData[] | import('..').SlotConfig> | undefined;
+        }[];
+        css: {
+            common?: string | undefined;
+            individual?: string | undefined;
+            special?: string | undefined;
+        };
+        parts: {
+            common: {
+                id: string;
+                type: string;
+                description: string;
+                parts: {
+                    id: string;
+                    title: string;
+                    description: string;
+                    body: string;
+                    slots?: Record<string, {
+                        allowedParts?: string[];
+                    }> | undefined;
+                    slotOnly?: boolean | undefined;
+                }[];
+            }[];
+            individual: {
+                id: string;
+                type: string;
+                description: string;
+                parts: {
+                    id: string;
+                    title: string;
+                    description: string;
+                    body: string;
+                    slots?: Record<string, {
+                        allowedParts?: string[];
+                    }> | undefined;
+                    slotOnly?: boolean | undefined;
+                }[];
+            }[];
+            special: {
+                id: string;
+                type: string;
+                description: string;
+                parts: {
+                    id: string;
+                    title: string;
+                    description: string;
+                    body: string;
+                    slots?: Record<string, {
+                        allowedParts?: string[];
+                    }> | undefined;
+                    slotOnly?: boolean | undefined;
+                }[];
+            }[];
+        };
+        images: {
+            common: {
+                id: string;
+                name: string;
+                url: string;
+                mimeType?: string | undefined;
+                needsUpload?: boolean | undefined;
+            }[];
+            individual: {
+                id: string;
+                name: string;
+                url: string;
+                mimeType?: string | undefined;
+                needsUpload?: boolean | undefined;
+            }[];
+            special: {
+                id: string;
+                name: string;
+                url: string;
+                mimeType?: string | undefined;
+                needsUpload?: boolean | undefined;
+            }[];
+        };
+        backendData?: Record<string, unknown> | undefined;
+    };
+    currentMode: import('vue').Ref<import('../features/editor/composables/useEditorMode').EditorMode, import('../features/editor/composables/useEditorMode').EditorMode>;
+    switchMode: (mode: import('../features/editor/composables/useEditorMode').EditorMode) => void;
+    allowDynamicContentInteraction: import('vue').Ref<NonNullable<boolean | undefined>, NonNullable<boolean | undefined>>;
+    devRightPadding: import('vue').Ref<NonNullable<boolean | undefined>, NonNullable<boolean | undefined>>;
+    devRightPaddingValue: import('vue').ComputedRef<NonNullable<boolean | undefined>>;
+    settingsPanelOpen: import('vue').Ref<boolean, boolean>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    containerRef: HTMLDivElement;
+    previewAreaRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+        cmsData: import('..').ZeroCodeData;
+        fullPageHtml: string;
+        onAddClick?: (path: string) => void;
+        allowDynamicContentInteraction?: boolean;
+    }> & Readonly<{}>, {
+        previewArea: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {}, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
+        previewArea: HTMLDivElement;
+        htmlContainer: HTMLDivElement;
+    }, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{
+        cmsData: import('..').ZeroCodeData;
+        fullPageHtml: string;
+        onAddClick?: (path: string) => void;
+        allowDynamicContentInteraction?: boolean;
+    }> & Readonly<{}>, {
+        previewArea: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
+    }, {}, {}, {}, {}> | null;
+}, HTMLDivElement>;
+export default _default;
+//# sourceMappingURL=ZeroCodeCMS.vue.d.ts.map

package/dist/components/ZeroCodeCMS.vue.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"ZeroCodeCMS.vue.d.ts","sourceRoot":"","sources":["../../src/components/ZeroCodeCMS.vue"],"names":[],"mappings":"AAyLA;AAg4BA,OAAO,EAAE,YAAY,IAAI,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAQ5E,KAAK,WAAW,GAAG;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAwDF,iBAAS,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,WAU7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCA/GD,CAn0BwB;;;;;;;;;;;;;;;oCAm0BxB,CAn0BwB;;;;;;;;;;;;;;;oCAm0BxB,CAn0BwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAk/DxB,wBASG"}