@stephenchenorg/astro 1.6.0 → 3.0.0

package/README.md

@@ -1,6 +1,10 @@
 # Stephenchenorg Astro 前端通用套件
 
-## 使用
+[![NPM version][ico-version]][link-npm]
+[![Software License][ico-license]](LICENSE)
+[![Total Downloads][ico-downloads]][link-downloads]
+
+## 安裝
 
 ```bash
 # npm
@@ -9,6 +13,10 @@ npm install @stephenchenorg/astro
 yarn add @stephenchenorg/astro
 ```
 
+## 文件
+
+https://stephenchenorg-astro.netlify.app
+
 ## 開發
 
 ```bash
@@ -16,9 +24,15 @@ yarn
 yarn build
 ```
 
-## 發布新版
+## 發布套件
 
 ```bash
 npm login
 npm run release
 ```
+
+[ico-version]: https://img.shields.io/npm/v/@stephenchenorg/astro?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square
+[ico-downloads]: https://img.shields.io/npm/dt/@stephenchenorg/astro?style=flat-square
+[link-npm]: https://www.npmjs.com/package/@stephenchenorg/astro
+[link-downloads]: https://www.npmjs.com/package/@stephenchenorg/astro

package/dist/api/fetch.d.ts

@@ -1,8 +1,13 @@
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import type { APIContext } from 'astro';
 export interface CreateGraphQLAPIOptions {
     endpoint: string;
-    defaultVariables?: Record<string, any> | (() => Record<string, any>);
-    fetchOptions?: RequestInit | (() => RequestInit);
+    defaultVariables?: Record<string, any> | ((astroContext?: APIContext) => Record<string, any>);
+    fetchOptions?: RequestInit | ((astroContext?: APIContext) => RequestInit);
 }
-export declare function createGraphQLAPI(options: CreateGraphQLAPIOptions): <TData extends Record<string, any>, TVariables extends Record<string, any> = Record<string, any>>(query: TypedDocumentNode<TData, TVariables>, variables?: TVariables, fetchOptions?: RequestInit) => Promise<TData>;
+export declare function createGraphQLAPI(globalOptions: CreateGraphQLAPIOptions): <TData extends Record<string, any>, TVariables extends Record<string, any> = Record<string, any>>(query: TypedDocumentNode<TData, TVariables>, options?: {
+    variables?: TVariables;
+    fetchOptions?: RequestInit;
+    Astro?: APIContext;
+}) => Promise<TData>;
 export { gql } from 'graphql-tag';

package/dist/api/fetch.js

@@ -1,14 +1,15 @@
 import { AwesomeGraphQLClient, GraphQLRequestError as AwesomeGraphQLRequestError } from "awesome-graphql-client";
 import { print } from "graphql/language/printer";
 import { GraphQLNotFoundError, GraphQLRequestError, GraphQLValidationError } from "./error.js";
-export function createGraphQLAPI(options) {
+export function createGraphQLAPI(globalOptions) {
   const client = new AwesomeGraphQLClient({
-    endpoint: options.endpoint,
+    endpoint: globalOptions.endpoint,
     formatQuery: (query) => print(query)
   });
-  return function graphQLAPI(query, variables, fetchOptions) {
-    const defaultVariables = typeof options.defaultVariables === "function" ? options.defaultVariables() : options.defaultVariables;
-    const defaultFetchOptions = typeof options.fetchOptions === "function" ? options.fetchOptions() : options.fetchOptions;
+  return function graphQLAPI(query, options) {
+    const { variables, fetchOptions, Astro: astroContext } = options || {};
+    const defaultVariables = typeof globalOptions.defaultVariables === "function" ? globalOptions.defaultVariables(astroContext) : globalOptions.defaultVariables;
+    const defaultFetchOptions = typeof globalOptions.fetchOptions === "function" ? globalOptions.fetchOptions(astroContext) : globalOptions.fetchOptions;
     return new Promise((resolve, reject) => {
       client.request(query, {
         ...defaultVariables,

package/dist/api/index.d.ts

@@ -1,3 +1,3 @@
-export * from './fetch';
 export * from './error';
 export * from './errorResponse';
+export * from './fetch';

package/dist/api/index.js

@@ -1,3 +1,3 @@
-export * from "./fetch.js";
 export * from "./error.js";
 export * from "./errorResponse.js";
+export * from "./fetch.js";

package/dist/company-setting/index.d.ts

@@ -1,3 +1,3 @@
-export * from './fragments';
 export * from './create';
+export * from './fragments';
 export * from './types';

package/dist/company-setting/index.js

@@ -1,3 +1,3 @@
-export * from "./fragments.js";
 export * from "./create.js";
+export * from "./fragments.js";
 export * from "./types.js";

package/dist/page/field/helpers.d.ts

@@ -1,7 +1,7 @@
-import type { PageContentField, PageField, PageImageField, PagePlainTextField, PagePlainTextareaField } from '../types';
+import type { PageContentField, PageField, PageImageField, PagePlainTextareaField, PagePlainTextField } from '../types';
 export declare function isPlainTextField(field: PageField): field is PagePlainTextField;
 export declare function isPlainTextareaField(field: PageField): field is PagePlainTextareaField;
 export declare function isContentField(field: PageField): field is PageContentField;
 export declare function isImageField(field: PageField): field is PageImageField;
-export declare function pageTextField(fields: PageField[], key: string): any;
+export declare function pageTextField(fields: PageField[], key: string): string | null;
 export declare function pageImageFieldForBackground(fields: PageField[], key: string): string;

package/dist/pagination-vue/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './usePagination';

package/dist/pagination-vue/index.js

@@ -0,0 +1,2 @@
+export * from "./types.js";
+export * from "./usePagination.js";

package/dist/pagination-vue/types.d.ts

@@ -0,0 +1,5 @@
+export interface Paginator<T> {
+    total: number;
+    per_page: number;
+    data: T[];
+}

package/dist/pagination-vue/usePagination.d.ts

@@ -0,0 +1,21 @@
+import type { MaybeRefOrGetter } from 'vue';
+export declare function usePagination(options: {
+    total: MaybeRefOrGetter<number>;
+    currentPage: MaybeRefOrGetter<number>;
+    url: string;
+    perPage?: MaybeRefOrGetter<number>;
+    visiblePages?: MaybeRefOrGetter<number>;
+}): {
+    items: import("vue").ComputedRef<number[]>;
+    showPagination: import("vue").ComputedRef<boolean>;
+    currentPage: import("vue").ComputedRef<number>;
+    canFirst: import("vue").ComputedRef<boolean>;
+    canPrev: import("vue").ComputedRef<boolean>;
+    canNext: import("vue").ComputedRef<boolean>;
+    canLast: import("vue").ComputedRef<boolean>;
+    firstUrl: import("vue").ComputedRef<string>;
+    prevUrl: import("vue").ComputedRef<string>;
+    nextUrl: import("vue").ComputedRef<string>;
+    lastUrl: import("vue").ComputedRef<string>;
+    getUrl: (page: number) => string;
+};

package/dist/pagination-vue/usePagination.js

@@ -0,0 +1,44 @@
+import { computed, toValue } from "vue";
+export function usePagination(options) {
+  const total = computed(() => toValue(options.total));
+  const currentPage = computed(() => toValue(options.currentPage));
+  const perPage = computed(() => toValue(options.perPage || 12));
+  const totalPages = computed(() => Math.ceil(total.value / perPage.value));
+  const visiblePages = computed(() => Math.min(toValue(options.visiblePages || 5), totalPages.value));
+  const sideCount = computed(() => Math.floor(visiblePages.value / 2));
+  const items = computed(() => {
+    const items2 = [];
+    let start = Math.max(1, currentPage.value - sideCount.value);
+    let end = Math.min(totalPages.value, currentPage.value + sideCount.value);
+    if (end - start + 1 < visiblePages.value && currentPage.value > 0) {
+      if (currentPage.value <= sideCount.value) {
+        end = Math.min(totalPages.value, start + visiblePages.value - 1);
+      } else if (currentPage.value > totalPages.value - sideCount.value) {
+        start = Math.max(1, end - visiblePages.value + 1);
+      }
+    }
+    for (let i = start; i <= end; i++) {
+      items2.push(i);
+    }
+    return items2;
+  });
+  function getUrl(page) {
+    const url = new URL(options.url);
+    url.searchParams.set("page", String(page));
+    return url.toString();
+  }
+  return {
+    items,
+    showPagination: computed(() => total.value > perPage.value),
+    currentPage,
+    canFirst: computed(() => currentPage.value > 1),
+    canPrev: computed(() => currentPage.value > 1),
+    canNext: computed(() => currentPage.value < totalPages.value),
+    canLast: computed(() => currentPage.value < totalPages.value),
+    firstUrl: computed(() => getUrl(1)),
+    prevUrl: computed(() => getUrl(currentPage.value - 1)),
+    nextUrl: computed(() => getUrl(currentPage.value + 1)),
+    lastUrl: computed(() => getUrl(totalPages.value)),
+    getUrl
+  };
+}

package/dist/query-params/index.d.ts

@@ -1,7 +1,7 @@
 import ProvideUrlConfig from './components/ProvideUrlConfig.astro';
 export * from './config';
 export * from './store';
+export * from './types';
 export * from './url';
 export * from './utils';
-export * from './types';
 export { ProvideUrlConfig };

package/dist/query-params/index.js

@@ -1,7 +1,7 @@
 import ProvideUrlConfig from "./components/ProvideUrlConfig.astro";
 export * from "./config.js";
 export * from "./store.js";
+export * from "./types.js";
 export * from "./url.js";
 export * from "./utils.js";
-export * from "./types.js";
 export { ProvideUrlConfig };

package/dist/query-params/url.d.ts

@@ -1,5 +1,5 @@
-import qs from 'query-string';
 import type { UrlConfig } from './types';
+import qs from 'query-string';
 declare global {
     interface Window {
         __astro_provide_url_config__?: UrlConfig;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stephenchenorg/astro",
   "type": "module",
-  "version": "1.6.0",
+  "version": "3.0.0",
   "description": "Stephenchenorg Astro 前端通用套件",
   "license": "MIT",
   "homepage": "https://stephenchenorg-astro.netlify.app",
@@ -29,9 +29,13 @@
       "types": "./dist/page/index.d.ts",
       "import": "./dist/page/index.js"
     },
-    "./pagination": {
-      "types": "./dist/pagination/index.d.ts",
-      "import": "./dist/pagination/index.js"
+    "./pagination-astro": {
+      "types": "./dist/pagination-astro/index.d.ts",
+      "import": "./dist/pagination-astro/index.js"
+    },
+    "./pagination-vue": {
+      "types": "./dist/pagination-vue/index.d.ts",
+      "import": "./dist/pagination-vue/index.js"
     },
     "./query-params": {
       "types": "./dist/query-params/index.d.ts",
@@ -55,31 +59,38 @@
     "node": ">=22"
   },
   "scripts": {
-    "build": "mkdist --declaration --ext=js",
+    "build": "mkdist --declaration --ext=js && sh ./scripts/postbuild.sh",
     "lint": "eslint \"*.{js,ts,json}\" \"src/**/*.ts\"",
     "code-check": "astro check && npm run lint",
     "prepack": "npm run build",
     "release": "bumpp --commit \"Release v%s\" && npm publish"
   },
   "peerDependencies": {
-    "astro": "^5.0.0"
+    "astro": "^5.0.0",
+    "vue": "^3.3.0"
+  },
+  "peerDependenciesMeta": {
+    "vue": {
+      "optional": true
+    }
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "^3.2.0",
     "awesome-graphql-client": "^2.1.0",
-    "graphql": "^16.10.0",
+    "graphql": "^16.11.0",
     "graphql-tag": "^2.12.6",
     "nanostores": "^1.0.1",
-    "query-string": "^9.1.2"
+    "query-string": "^9.2.0"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.4",
-    "@ycs77/eslint-config": "^4.1.0",
-    "astro": "^5.7.10",
-    "bumpp": "^10.1.0",
-    "eslint": "^9.26.0",
+    "@ycs77/eslint-config": "^4.3.0",
+    "astro": "^5.9.1",
+    "bumpp": "^10.1.1",
+    "eslint": "^9.28.0",
     "eslint-plugin-astro": "^1.3.1",
     "mkdist": "^2.3.0",
-    "typescript": "~5.8.3"
+    "typescript": "^5.8.3",
+    "vue": "^3.5.16"
   }
 }

package/dist/pagination/stub/Pagination.astro

@@ -1,45 +0,0 @@
----
-import { usePagination } from '@stephenchenorg/astro/pagination'
-
-interface Props {
-  total: number
-  perPage?: number
-  visiblePages?: number
-  currentPage?: number
-}
-
-const {
-  items,
-  showPagination,
-  currentPage,
-  canFirst,
-  canPrev,
-  canNext,
-  canLast,
-  firstUrl,
-  prevUrl,
-  nextUrl,
-  lastUrl,
-  getUrl,
-} = usePagination({
-  total: Astro.props.total,
-  perPage: Astro.props.perPage,
-  visiblePages: Astro.props.visiblePages,
-  currentPage: Astro.props.currentPage || Number(Astro.url.searchParams.get('page')) || 1,
-  url: Astro.request.url,
-})
----
-
-{showPagination && (
-  <div>
-    {canFirst && <a href={firstUrl}>First</a>}
-    {canPrev && <a href={prevUrl}>Previous</a>}
-    {items.map(page =>
-      page === currentPage
-        ? <span>{page}</span>
-        : <a href={getUrl(page)}>{page}</a>
-    )}
-    {canNext && <a href={nextUrl}>Next</a>}
-    {canLast && <a href={lastUrl}>Last</a>}
-  </div>
-)}

package/dist/{pagination → pagination-astro}/index.d.ts

@@ -1,2 +1,2 @@
-export * from './usePagination';
 export * from './types';
+export * from './usePagination';

package/dist/{pagination → pagination-astro}/index.js

@@ -1,2 +1,2 @@
-export * from "./usePagination.js";
 export * from "./types.js";
+export * from "./usePagination.js";