initial

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -0,0 +1,20 @@
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -0,0 +1,18 @@
+{
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "apiclient.xyz",
+      "gitrepo": "ghost",
+      "description": "an unofficial ghost api package",
+      "npmPackagename": "@apiclient.xyz/ghost",
+      "license": "MIT",
+      "projectDomain": "apiclient.xyz"
+    }
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@apiclient.xyz/ghost",
+  "version": "1.0.1",
+  "private": false,
+  "description": "an unofficial ghost api package",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
+  "author": "Task Venture Capital GmbH",
+  "license": "MIT",
+  "scripts": {
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "(tsdoc)"
+  },
+  "devDependencies": {
+    "@git.zone/tsbuild": "^2.1.82",
+    "@git.zone/tsbundle": "^2.0.5",
+    "@git.zone/tsrun": "^1.2.49",
+    "@git.zone/tstest": "^1.0.44",
+    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/tapbundle": "^5.0.15",
+    "@types/node": "^20.14.9"
+  },
+  "dependencies": {
+    "@tryghost/admin-api": "^1.13.12",
+    "@tryghost/content-api": "^1.11.21"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://code.foss.global/apiclient.xyz/ghost.git"
+  },
+  "bugs": {
+    "url": "https://code.foss.global/apiclient.xyz/ghost/issues"
+  },
+  "homepage": "https://code.foss.global/apiclient.xyz/ghost#readme",
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
+}

readme.md

@@ -0,0 +1,31 @@
+# @apiclient.xyz/ghost
+an unofficial ghost api package
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@apiclient.xyz/ghost)
+* [gitlab.com (source)](https://code.foss.global/apiclient.xyz/ghost)
+* [github.com (source mirror)](https://github.com/apiclient.xyz/ghost)
+* [docs (typedoc)](https://apiclient.xyz.gitlab.io/ghost/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://code.foss.global/apiclient.xyz/ghost/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://code.foss.global/apiclient.xyz/ghost/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@apiclient.xyz/ghost)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/apiclient.xyz/ghost)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@apiclient.xyz/ghost)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiclient.xyz/ghost)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiclient.xyz/ghost)](https://lossless.cloud)
+
+## Usage
+Use TypeScript for best in class intellisense
+For further information read the linked docs at the top of this readme.
+
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

test/test.ts

@@ -0,0 +1,25 @@
+import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import * as qenv from '@push.rocks/qenv';
+const testQenv = new qenv.Qenv('./', './.nogit/');
+
+import * as ghost from '../ts/index.js'
+
+let testGhostInstance: ghost.Ghost;
+
+tap.test('should create a valid instance of Ghost', async () => {
+  testGhostInstance = new ghost.Ghost({
+    baseUrl: 'https://coffee.link',
+    adminApiKey: await testQenv.getEnvVarOnDemand('ADMIN_APIKEY'),
+    contentApiKey: await testQenv.getEnvVarOnDemand('CONTENT_APIKEY'),
+  });
+  expect(testGhostInstance).toBeInstanceOf(ghost.Ghost);
+});
+
+tap.test('should get posts', async () => {
+  const posts = await testGhostInstance.getPosts();
+  expect(posts).toBeArray();
+  expect(posts[0]).toBeInstanceOf(ghost.Post);
+  console.log(posts.map((post) => post.getTitle()));
+})
+
+tap.start()

ts/classes.ghost.ts

@@ -0,0 +1,60 @@
+import * as plugins from './ghost.plugins.js';
+import { Post, type IPostOptions } from './classes.post.js';
+
+export interface IGhostConstructorOptions {
+  baseUrl: string;
+  contentApiKey: string;
+  adminApiKey: string;
+}
+
+export class Ghost {
+  public options: IGhostConstructorOptions;
+  public adminApi: any;
+  public contentApi: any;
+
+  constructor(optionsArg: IGhostConstructorOptions) {
+    this.options = optionsArg;
+
+    this.adminApi = new plugins.GhostAdminAPI({
+      url: this.options.baseUrl,
+      key: this.options.adminApiKey,
+      version: "v3"
+    });
+
+    this.contentApi = new plugins.GhostContentAPI({
+      url: this.options.baseUrl,
+      key: this.options.contentApiKey,
+      version: "v3"
+    });
+  }
+
+  public async getPosts(limit: number = 1000): Promise<Post[]> {
+    try {
+      const postsData = await this.contentApi.posts.browse({ limit });
+      return postsData.map((postData: IPostOptions) => new Post(this, postData));
+    } catch (error) {
+      console.error('Error fetching posts:', error);
+      throw error;
+    }
+  }
+
+  public async getPostById(id: string): Promise<Post> {
+    try {
+      const postData = await this.contentApi.posts.read({ id });
+      return new Post(postData, this.adminApi);
+    } catch (error) {
+      console.error(`Error fetching post with id ${id}:`, error);
+      throw error;
+    }
+  }
+
+  public async createPost(postData: IPostOptions): Promise<Post> {
+    try {
+      const createdPostData = await this.adminApi.posts.add(postData);
+      return new Post(createdPostData, this.adminApi);
+    } catch (error) {
+      console.error('Error creating post:', error);
+      throw error;
+    }
+  }
+}

ts/classes.post.ts

@@ -0,0 +1,70 @@
+import type { Ghost } from './classes.ghost.js';
+import * as plugins from './ghost.plugins.js';
+
+export interface IPostOptions {
+  id: string;
+  title: string;
+  html: string;
+  excerpt?: string;
+  feature_image?: string;
+  [key: string]: any; // To allow for additional properties
+}
+
+export class Post {
+  public ghostInstanceRef: Ghost;
+  private postData: IPostOptions;
+
+  constructor(ghostInstanceRefArg: Ghost, postData: IPostOptions) {
+    this.ghostInstanceRef = ghostInstanceRefArg;
+    this.postData = postData;
+  }
+
+  public getId(): string {
+    return this.postData.id;
+  }
+
+  public getTitle(): string {
+    return this.postData.title;
+  }
+
+  public getHtml(): string {
+    return this.postData.html;
+  }
+
+  public getExcerpt(): string {
+    return this.postData.excerpt || this.generateExcerpt();
+  }
+
+  public getFeatureImage(): string | undefined {
+    return this.postData.feature_image;
+  }
+
+  public toJson(): IPostOptions {
+    return this.postData;
+  }
+
+  public async update(postData: IPostOptions): Promise<Post> {
+    try {
+      const updatedPostData = await this.ghostInstanceRef.adminApi.posts.edit(postData);
+      this.postData = updatedPostData;
+      return this;
+    } catch (error) {
+      console.error('Error updating post:', error);
+      throw error;
+    }
+  }
+
+  public async delete(): Promise<void> {
+    try {
+      await this.ghostInstanceRef.adminApi.posts.delete({ id: this.getId() });
+    } catch (error) {
+      console.error(`Error deleting post with id ${this.getId()}:`, error);
+      throw error;
+    }
+  }
+
+  private generateExcerpt(length: number = 100): string {
+    const plainText = this.postData.html.replace(/<[^>]+>/g, ''); // Strip HTML tags
+    return plainText.length > length ? plainText.substring(0, length) + '...' : plainText;
+  }
+}

ts/ghost.plugins.ts

@@ -0,0 +1,7 @@
+import GhostContentAPI from '@tryghost/content-api';
+import GhostAdminAPI from '@tryghost/admin-api';
+
+export {
+  GhostContentAPI,
+  GhostAdminAPI
+}

ts/index.ts

@@ -0,0 +1,2 @@
+export * from './classes.ghost.js';
+export * from './classes.post.js';

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}