@sneat/extension-yardius-contract 0.1.0 → 0.2.0

package/dist/lib/friendship.d.ts

@@ -0,0 +1,42 @@
+import { InjectionToken } from '@angular/core';
+import type { Observable } from 'rxjs';
+export type SpaceFriendshipRole = 'friend' | 'neighbour';
+export interface ICreateFriendshipInviteRequest {
+    readonly spaceID: string;
+    readonly role?: SpaceFriendshipRole;
+}
+export interface ICreateFriendshipInviteResponse {
+    readonly id: string;
+    readonly pin: string;
+}
+export interface IAcceptFriendshipInviteRequest {
+    readonly inviteID: string;
+    readonly pin: string;
+    readonly toSpaceID: string;
+}
+export interface IAcceptFriendshipInviteResponse {
+    readonly invitingSpaceID: string;
+    readonly toSpaceID: string;
+    readonly role: SpaceFriendshipRole;
+}
+export interface IFriendSpace {
+    readonly id: string;
+    readonly roles: readonly SpaceFriendshipRole[];
+    readonly title?: string;
+}
+export interface IListFriendSpacesResponse {
+    readonly friendSpaces?: readonly IFriendSpace[];
+}
+export interface IRemoveFriendshipRequest {
+    readonly spaceID: string;
+    readonly friendSpaceID: string;
+}
+export interface IYardiusFriendshipService {
+    createFriendshipInvite(request: ICreateFriendshipInviteRequest): Observable<ICreateFriendshipInviteResponse>;
+    acceptFriendshipInvite(request: IAcceptFriendshipInviteRequest): Observable<IAcceptFriendshipInviteResponse>;
+    listFriendSpaces(spaceID: string): Observable<IListFriendSpacesResponse>;
+    removeFriendship(request: IRemoveFriendshipRequest): Observable<void>;
+}
+export declare const YARDIUS_FRIENDSHIP_SERVICE: InjectionToken<IYardiusFriendshipService>;
+export declare const BEFRIEND_SPACE_PAGE_PATH = "befriend";
+export declare function friendshipInvitePath(inviteID: string, pin: string): string;

package/dist/lib/friendship.js

@@ -0,0 +1,6 @@
+import { InjectionToken } from '@angular/core';
+export const YARDIUS_FRIENDSHIP_SERVICE = new InjectionToken('YardiusFriendshipService');
+export const BEFRIEND_SPACE_PAGE_PATH = 'befriend';
+export function friendshipInvitePath(inviteID, pin) {
+    return `${BEFRIEND_SPACE_PAGE_PATH}?${new URLSearchParams({ id: inviteID, pin }).toString()}`;
+}

package/dist/lib/index.d.ts

@@ -1,4 +1,5 @@
 export * from './assetus-visibility.js';
+export * from './friendship.js';
 export * from './listing-visibility.js';
 export * from './state-transitions.js';
 export * from './borrow-state.js';

package/dist/lib/index.js

@@ -1,4 +1,5 @@
 export * from './assetus-visibility.js';
+export * from './friendship.js';
 export * from './listing-visibility.js';
 export * from './state-transitions.js';
 export * from './borrow-state.js';

package/dist/lib/listing-visibility.d.ts

@@ -2,6 +2,7 @@ import { AssetusVisibility } from './assetus-visibility.js';
 export declare const LISTING_VISIBILITIES: readonly ["private", "members", "friends"];
 export type ListingVisibility = (typeof LISTING_VISIBILITIES)[number];
 export declare const DEFAULT_LISTING_VISIBILITY: ListingVisibility;
+export declare function listingVisibilityLabel(visibility: ListingVisibility): string;
 export declare const LISTING_VISIBILITY_CEILING: Readonly<Record<AssetusVisibility, readonly ListingVisibility[]>>;
 export declare function allowedListingVisibilities(assetVisibility: AssetusVisibility): readonly ListingVisibility[];
 export declare function isListingVisibilityAllowed(assetVisibility: AssetusVisibility, listingVisibility: ListingVisibility): boolean;

package/dist/lib/listing-visibility.js

@@ -10,6 +10,16 @@ export const LISTING_VISIBILITIES = ['private', 'members', 'friends'];
 // Per REQ listing-visibility-ceiling: `members` is the default listing
 // visibility.
 export const DEFAULT_LISTING_VISIBILITY = 'members';
+export function listingVisibilityLabel(visibility) {
+    switch (visibility) {
+        case 'private':
+            return 'Private';
+        case 'members':
+            return 'Members';
+        case 'friends':
+            return 'Friends';
+    }
+}
 // The asset's Assetus visibility is a CEILING on the listing's visibility,
 // per this exact mapping from REQ listing-visibility-ceiling:
 //

package/dist/lib/listing.d.ts

@@ -1,22 +1,108 @@
-import { BorrowState } from './borrow-state.js';
-import { GiveawayState } from './giveaway-state.js';
-import { ListingVisibility } from './listing-visibility.js';
+import { InjectionToken } from '@angular/core';
+import type { Observable } from 'rxjs';
+import type { BorrowState } from './borrow-state.js';
+import type { GiveawayState } from './giveaway-state.js';
+import type { ListingRequestStatus } from './listing-request.js';
+import type { ListingVisibility } from './listing-visibility.js';
+import type { IGetListingsResponse } from './listings-endpoint.js';
 export declare const LISTING_TYPES: readonly ["borrow", "giveaway"];
 export type ListingType = (typeof LISTING_TYPES)[number];
 export type ListingState = BorrowState | GiveawayState;
-interface IListingBase {
-    readonly id: string;
-    readonly spaceID: string;
+export declare function isOpenListingState(state: ListingState): boolean;
+export declare function listingTypeLabel(type: ListingType): string;
+export declare function listingStateLabel(state: ListingState): string;
+export declare function listingRequestStatusLabel(status: ListingRequestStatus): string;
+export interface IListingDbo {
     readonly assetID: string;
+    readonly type: ListingType;
+    readonly state: ListingState;
     readonly visibility: ListingVisibility;
+    readonly createdAt?: string;
+    readonly createdBy?: string;
 }
-export interface IBorrowListingDto extends IListingBase {
+interface IListingIdentity {
+    readonly id: string;
+    readonly spaceID: string;
+}
+export interface IBorrowListingDto extends IListingDbo, IListingIdentity {
     readonly type: 'borrow';
     readonly state: BorrowState;
 }
-export interface IGiveawayListingDto extends IListingBase {
+export interface IGiveawayListingDto extends IListingDbo, IListingIdentity {
     readonly type: 'giveaway';
     readonly state: GiveawayState;
 }
 export type IListingDto = IBorrowListingDto | IGiveawayListingDto;
+export interface IPublishListingRequest {
+    readonly spaceID: string;
+    readonly assetID: string;
+    readonly type: ListingType;
+    readonly visibility?: ListingVisibility;
+}
+export interface IListingActionResponse {
+    readonly id: string;
+    readonly listing: IListingDbo;
+}
+export interface IListingActionRequest {
+    readonly spaceID: string;
+    readonly listingID: string;
+}
+export interface IListingRequestActionRequest extends IListingActionRequest {
+    readonly requestID: string;
+}
+export interface IApproveRequestResponse extends IListingActionResponse {
+    readonly declinedRequestIDs?: readonly string[];
+}
+export interface IRequestToBorrowRequest {
+    readonly spaceID: string;
+    readonly ownerSpaceID: string;
+    readonly listingID: string;
+}
+export interface IWithdrawRequestRequest extends IRequestToBorrowRequest {
+    readonly requestID: string;
+}
+export type AvailableListingSource = 'member' | 'friend';
+export interface IAvailableListingDto {
+    readonly spaceID: string;
+    readonly spaceTitle?: string;
+    readonly listingID: string;
+    readonly assetID: string;
+    readonly type: ListingType;
+    readonly state: ListingState;
+    readonly visibility: ListingVisibility;
+    readonly source: AvailableListingSource;
+}
+export interface IMyRequestDto {
+    readonly id: string;
+    readonly ownerSpaceID: string;
+    readonly ownerSpaceTitle?: string;
+    readonly listingID: string;
+    readonly assetID: string;
+    readonly type: ListingType;
+    readonly status: ListingRequestStatus;
+    readonly createdAt: string;
+}
+export interface IGetMyRequestsResponse {
+    readonly requests: readonly IMyRequestDto[];
+}
+export interface IGetListingResult {
+    readonly listing?: IListingDto;
+    readonly requests?: readonly import('./listing-request.js').IListingRequestDto[];
+}
+export interface IYardiusListingService {
+    publishListing(request: IPublishListingRequest): Observable<IListingActionResponse>;
+    cancelListing(request: IListingActionRequest): Observable<IListingActionResponse>;
+    requestToBorrow(request: IRequestToBorrowRequest): Observable<IListingActionResponse>;
+    claimListing(request: IRequestToBorrowRequest): Observable<IListingActionResponse>;
+    withdrawRequest(request: IWithdrawRequestRequest): Observable<IListingActionResponse>;
+    approveRequest(request: IListingRequestActionRequest): Observable<IApproveRequestResponse>;
+    declineRequest(request: IListingRequestActionRequest): Observable<IListingActionResponse>;
+    confirmHandover(request: IListingActionRequest): Observable<IListingActionResponse>;
+    confirmReturn(request: IListingActionRequest): Observable<IListingActionResponse>;
+    getAvailableListings(): Observable<IGetListingsResponse>;
+    getOurListings(spaceID: string): Observable<readonly IListingDto[]>;
+    getListing(spaceID: string, listingID: string): Observable<IGetListingResult>;
+    getMyRequests(): Observable<IGetMyRequestsResponse>;
+}
+export declare const YARDIUS_LISTING_SERVICE: InjectionToken<IYardiusListingService>;
 export {};

package/dist/lib/listing.js

@@ -1,3 +1,15 @@
-// A Listing's transaction type, per REQ publish-listing: exactly `borrow` or
-// `giveaway`. Sell / swap / reserve are explicitly out of MVP scope.
+import { InjectionToken } from '@angular/core';
 export const LISTING_TYPES = ['borrow', 'giveaway'];
+export function isOpenListingState(state) {
+    return state !== 'closed';
+}
+export function listingTypeLabel(type) {
+    return type === 'borrow' ? 'Borrow' : 'Give away';
+}
+export function listingStateLabel(state) {
+    return state.charAt(0).toUpperCase() + state.slice(1);
+}
+export function listingRequestStatusLabel(status) {
+    return status.charAt(0).toUpperCase() + status.slice(1);
+}
+export const YARDIUS_LISTING_SERVICE = new InjectionToken('YardiusListingService');

package/dist/lib/listings-endpoint.d.ts

@@ -1,4 +1,4 @@
-import { IListingDto } from './listing.js';
+import type { IAvailableListingDto, IListingDto } from './listing.js';
 export type IGetListingsRequest = Record<string, never>;
 export type ListingsGroupReason = 'member' | 'friend';
 export interface IListingsSpaceGroup {
@@ -8,5 +8,8 @@ export interface IListingsSpaceGroup {
     readonly listings: readonly IListingDto[];
 }
 export interface IGetListingsResponse {
-    readonly groups: readonly IListingsSpaceGroup[];
+    /** Grouped response used by the relationship-first listing endpoint. */
+    readonly groups?: readonly IListingsSpaceGroup[];
+    /** Flat response used by the existing `get_available_listings` facade. */
+    readonly listings?: readonly IAvailableListingDto[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sneat/extension-yardius-contract",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Frozen cross-repo contract surface (shared DTOs, consts, briefs) for the yardius Sneat extension",
   "license": "MIT",
   "repository": {
@@ -23,12 +23,18 @@
     "access": "public"
   },
   "devDependencies": {
+    "@angular/core": "^21.0.0",
     "@nx/js": "22.7.5",
     "nx": "22.7.5",
+    "rxjs": "^7.0.0",
     "typescript": "~5.9.3",
     "vite": "^7.2.7",
     "vitest": "4.0.9"
   },
+  "peerDependencies": {
+    "@angular/core": "^21.0.0",
+    "rxjs": "^7.0.0"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc --noEmit",