welcome back to dyb-tech

vendor/lcobucci/jwt/src/Builder.php

@@ -0,0 +1,85 @@
+<?php
+declare(strict_types=1);
+
+namespace Lcobucci\JWT;
+
+use DateTimeImmutable;
+use Lcobucci\JWT\Encoding\CannotEncodeContent;
+use Lcobucci\JWT\Signer\CannotSignPayload;
+use Lcobucci\JWT\Signer\Ecdsa\ConversionFailed;
+use Lcobucci\JWT\Signer\InvalidKeyProvided;
+use Lcobucci\JWT\Signer\Key;
+use Lcobucci\JWT\Token\RegisteredClaimGiven;
+
+/** @immutable */
+interface Builder
+{
+    /**
+     * Appends new items to audience
+     *
+     * @param non-empty-string ...$audiences
+     */
+    public function permittedFor(string ...$audiences): Builder;
+
+    /**
+     * Configures the expiration time
+     */
+    public function expiresAt(DateTimeImmutable $expiration): Builder;
+
+    /**
+     * Configures the token id
+     *
+     * @param non-empty-string $id
+     */
+    public function identifiedBy(string $id): Builder;
+
+    /**
+     * Configures the time that the token was issued
+     */
+    public function issuedAt(DateTimeImmutable $issuedAt): Builder;
+
+    /**
+     * Configures the issuer
+     *
+     * @param non-empty-string $issuer
+     */
+    public function issuedBy(string $issuer): Builder;
+
+    /**
+     * Configures the time before which the token cannot be accepted
+     */
+    public function canOnlyBeUsedAfter(DateTimeImmutable $notBefore): Builder;
+
+    /**
+     * Configures the subject
+     *
+     * @param non-empty-string $subject
+     */
+    public function relatedTo(string $subject): Builder;
+
+    /**
+     * Configures a header item
+     *
+     * @param non-empty-string $name
+     */
+    public function withHeader(string $name, mixed $value): Builder;
+
+    /**
+     * Configures a claim item
+     *
+     * @param non-empty-string $name
+     *
+     * @throws RegisteredClaimGiven When trying to set a registered claim.
+     */
+    public function withClaim(string $name, mixed $value): Builder;
+
+    /**
+     * Returns a signed token to be used
+     *
+     * @throws CannotEncodeContent When data cannot be converted to JSON.
+     * @throws CannotSignPayload   When payload signing fails.
+     * @throws InvalidKeyProvided  When issue key is invalid/incompatible.
+     * @throws ConversionFailed    When signature could not be converted.
+     */
+    public function getToken(Signer $signer, Key $key): UnencryptedToken;
+}