feat: define Instance model

pkg/federation/model/__snapshots__/instance.test.ts.snap

@@ -0,0 +1,22 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Instance > should create new instance 1`] = `
+Instance {
+  "adminContact": "https://example.com/contact",
+  "adminName": "Pulsate project",
+  "deliverState": "normal",
+  "description": "pulsate official instance",
+  "firstContact": 2023-09-10T00:00:00.000Z,
+  "fqdn": "social.example.com:3000",
+  "id": "1",
+  "isLocal": true,
+  "name": "Pulsate social",
+  "silenced": "normal",
+  "softwareName": "Pulsate",
+  "softwareVersion": "0.1.0",
+  "state": "normal",
+  "updated": [
+    Symbol(OptionNone),
+  ],
+}
+`;

pkg/federation/model/instance.test.ts

@@ -0,0 +1,39 @@
+import { describe, expect, it } from 'vitest';
+import { Instance, type InstanceID } from './instance.js';
+
+describe('Instance', () => {
+  it('should create new instance', () => {
+    const res = Instance.new({
+      id: '1' as InstanceID,
+      name: 'Pulsate social',
+      fqdn: new URL('https://social.example.com:3000'),
+      softwareName: 'Pulsate',
+      softwareVersion: '0.1.0',
+      adminName: 'Pulsate project',
+      description: 'pulsate official instance',
+      adminContact: 'https://example.com/contact',
+      isLocal: true,
+      firstContact: new Date('2023-09-10T00:00:00.000Z'),
+    });
+
+    expect(res).toMatchSnapshot();
+  });
+
+  it('should set Unknown/Unknwon if software version or name empty', () => {
+    const res = Instance.new({
+      id: '1' as InstanceID,
+      name: 'Pulsate social',
+      fqdn: new URL('https://social.example.com:3000'),
+      softwareName: '',
+      softwareVersion: '',
+      adminName: 'Pulsate project',
+      description: 'pulsate official instance',
+      adminContact: 'https://example.com/contact',
+      isLocal: true,
+      firstContact: new Date('2023-09-10T00:00:00.000Z'),
+    });
+
+    expect(res.getSoftwareName()).toBe('Unknown');
+    expect(res.getSoftwareVersion()).toBe('Unknown');
+  });
+});

pkg/federation/model/instance.ts

@@ -0,0 +1,310 @@
+import { Option } from '@mikuroxina/mini-fn';
+import type { ID } from '../../id/type.js';
+
+export type InstanceID = ID<Instance>;
+export type InstanceState = 'normal' | 'blocked';
+export type InstanceSilenced = 'normal' | 'silenced';
+export type InstanceDeliverState = 'normal' | 'stopped';
+
+export interface CreateInstanceArgs {
+  id: InstanceID;
+  name: string;
+  description: string;
+  fqdn: URL;
+  softwareName: string;
+  softwareVersion: string;
+  adminName: string;
+  adminContact: string;
+  isLocal: boolean;
+  firstContact: Date;
+  // private
+  state: InstanceState;
+  silenced: InstanceSilenced;
+  deliverState: InstanceDeliverState;
+  updated: Option.Option<Date>;
+}
+
+export class Instance {
+  /**
+   * Instance ID
+   * @type {@link InstanceID}
+   * @example "30840483483726295"
+   */
+  private readonly id: InstanceID;
+  /**
+   * Instance name
+   * @example "Pulsate social"
+   */
+  private name: string;
+  /**
+   * Instance description
+   * @example
+   * ```
+   * Pulsate official instance
+   * ```
+   */
+  private description: string;
+  /**
+   * Instance FQDN
+   * @example "pulsate.social"
+   */
+  private readonly fqdn: string;
+  /**
+   * Software name
+   * @example "Pulsate"
+   */
+  private readonly softwareName: string;
+  /**
+   * Software version
+   * @example "1.0.0"
+   */
+  private softwareVersion: string;
+  /**
+   * Instance admin name
+   * @example "Pulsate project"
+   */
+  private adminName: string;
+  /**
+   * Instance admin contact
+   * @example "[email protected]"
+   * @example "https://pulsate.dev/contact"
+   */
+  private adminContact: string;
+  /**
+   * Instance state
+   * - `normal` - Instance is active
+   * - `blocked` - Instance is blocked(reject all activity)
+   */
+  private state: InstanceState;
+  /**
+   * Instance silenced state
+   * - `normal` - Instance is not silenced
+   * - `silenced` - Instance is silenced (all PUBLIC notes visibility sets to HOME)
+   */
+  private silenced: InstanceSilenced;
+  /**
+   * Instance deliver state
+   * - `normal` - Instance is delivering notes
+   * - `stopped` - Instance is not delivering notes
+   */
+  private deliverState: InstanceDeliverState;
+  /**
+   * Instance isLocal flag
+   * - `true` - Instance is local
+   * - `false` - Instance is remote
+   */
+  private readonly isLocal: boolean;
+
+  /**
+   * Instance first contact date
+   */
+  private readonly firstContact: Date;
+  /**
+   * Instance data updated date
+   */
+  private updated: Option.Option<Date>;
+
+  /**
+   * Instance ID
+   * @returns Instance ID
+   */
+  getID(): InstanceID {
+    return this.id;
+  }
+
+  /**
+   * Instance Name
+   * @returns Instance name
+   */
+  getName(): string {
+    return this.name;
+  }
+
+  /**
+   * Set instance name
+   * @param name Instance name
+   */
+  setName(name: string) {
+    this.name = name;
+    this.setUpdated();
+  }
+
+  /**
+   * Instance description
+   * @returns Instance description
+   */
+  getDescription(): string {
+    return this.description;
+  }
+
+  /**
+   * Set instance description
+   * @param description Instance description
+   */
+  setDescription(description: string) {
+    this.description = description;
+    this.setUpdated();
+  }
+
+  /**
+   * Instance FQDN
+   * @returns Instance FQDN
+   */
+  getFQDN(): string {
+    return this.fqdn;
+  }
+
+  /**
+   * Software name
+   * @returns Software name
+   */
+  getSoftwareName(): string {
+    return this.softwareName;
+  }
+
+  /**
+   * Software version
+   * @returns Software version
+   */
+  getSoftwareVersion(): string {
+    return this.softwareVersion;
+  }
+
+  /**
+   * Set instance software version
+   * @param version Software version
+   */
+  setSoftwareVersion(version: string) {
+    this.softwareVersion = version;
+    this.setUpdated();
+  }
+
+  /**
+   * Instance admin name
+   * @returns Instance admin name
+   */
+  getAdminName(): string {
+    return this.adminName;
+  }
+
+  /**
+   * Set instance admin name
+   * @param name Admin name
+   */
+  setAdminName(name: string) {
+    this.adminName = name;
+    this.setUpdated();
+  }
+
+  /**
+   * Instance admin contact
+   * @returns Instance admin contact
+   */
+  getAdminContact(): string {
+    return this.adminContact;
+  }
+
+  /**
+   * Set instance admin contact
+   * @param contact Admin contact
+   */
+  setAdminContact(contact: string) {
+    this.adminContact = contact;
+    this.setUpdated();
+  }
+
+  isBlocked(): boolean {
+    return this.state === 'blocked';
+  }
+
+  /**
+   * Set instance state
+   */
+  setInstanceState(state: InstanceState) {
+    this.state = state;
+    this.setUpdated();
+  }
+
+  isSilenced(): boolean {
+    return this.silenced === 'silenced';
+  }
+
+  /**
+   * Set instance silenced state
+   */
+  setSilencedState(silenced: InstanceSilenced) {
+    this.silenced = silenced;
+    this.setUpdated();
+  }
+
+  isDeliverStopped(): boolean {
+    return this.deliverState === 'stopped';
+  }
+
+  /**
+   * Set instance deliver state
+   */
+  setDeliverState(state: InstanceDeliverState) {
+    this.deliverState = state;
+    this.setUpdated();
+  }
+
+  isLocalInstance(): boolean {
+    return this.isLocal;
+  }
+
+  /**
+   * Instance first contact date
+   * @returns Instance first contact date
+   */
+  getFirstContact(): Date {
+    return this.firstContact;
+  }
+
+  /**
+   * Instance data updated date
+   * @returns Instance data updated date
+   */
+  getUpdated(): Option.Option<Date> {
+    return this.updated;
+  }
+
+  private setUpdated() {
+    this.updated = Option.some(new Date());
+  }
+
+  private constructor(arg: CreateInstanceArgs) {
+    this.id = arg.id;
+    this.name = arg.name;
+    this.description = arg.description;
+    this.fqdn = arg.fqdn.host;
+    this.softwareName = arg.softwareName;
+    this.softwareVersion = arg.softwareVersion;
+    this.adminName = arg.adminName;
+    this.adminContact = arg.adminContact;
+    this.isLocal = arg.isLocal;
+    this.firstContact = arg.firstContact;
+    this.state = arg.state;
+    this.silenced = arg.silenced;
+    this.deliverState = arg.deliverState;
+    this.updated = arg.updated;
+  }
+
+  public static new(
+    arg: Omit<
+      CreateInstanceArgs,
+      'state' | 'silenced' | 'deliverState' | 'updated'
+    >,
+  ): Instance {
+    if (arg.softwareName === '') arg.softwareName = 'Unknown';
+    if (arg.softwareVersion === '') arg.softwareVersion = 'Unknown';
+
+    return new Instance({
+      ...arg,
+      state: 'normal',
+      silenced: 'normal',
+      deliverState: 'normal',
+      updated: Option.none(),
+    });
+  }
+}